Transformation Guide
Informatica PowerCenter®
(Version 7.1.1)
Informatica PowerCenter Transformation Guide
Version 7.1.1
August 2004
Copyright (c) 1998–2004 Informatica Corporation.
All rights reserved. Printed in the USA.
This software and documentation contain proprietary information of Informatica Corporation, they are provided under a license agreement
containing restrictions on use and disclosure and is also protected by copyright law. Reverse engineering of the software is prohibited. No
part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise)
without prior consent of Informatica Corporation.
Use, duplication, or disclosure of the Software by the U.S. Government is subject to the restrictions set forth in the applicable software
license agreement as provided in DFARS 227.7202-1(a) and 227.7702-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR
12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14 (ALT III), as applicable.
The information in this document is subject to change without notice. If you find any problems in the documentation, please report them to
us in writing. Informatica Corporation does not warrant that this documentation is error free.
Informatica, PowerMart, PowerCenter, PowerChannel, PowerConnect, MX, and SuperGlue are trademarks or registered trademarks of
Informatica Corporation in the United States and in jurisdictions throughout the world. All other company and product names may be trade
names or trademarks of their respective owners.
Portions of this software are copyrighted by DataDirect Technologies, 1999-2002.
Informatica PowerCenter products contain ACE (TM) software copyrighted by Douglas C. Schmidt and his research group at Washington
University and University of California, Irvine, Copyright (c) 1993-2002, all rights reserved.
Portions of this software contain copyrighted material from The JBoss Group, LLC. Your right to use such materials is set forth in the GNU
Lesser General Public License Agreement, which may be found at http://www.opensource.org/licenses/lgpl-license.php. The JBoss materials
are provided free of charge by Informatica, “as-is”, without warranty of any kind, either express or implied, including but not limited to the
implied warranties of merchantability and fitness for a particular purpose.
Portions of this software contain copyrighted material from Meta Integration Technology, Inc. Meta Integration® is a registered trademark
of Meta Integration Technology, Inc.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
The Apache Software is Copyright (c) 1999-2004 The Apache Software Foundation. All rights reserved.
DISCLAIMER: Informatica Corporation provides this documentation “as is” without warranty of any kind, either express or implied,
including, but not limited to, the implied warranties of non-infringement, merchantability, or use for a particular purpose. The information
provided in this documentation may include technical inaccuracies or typographical errors. Informatica could make improvements and/or
changes in the products described in this documentation at any time without notice.
Table of Contents
List of Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
List of Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
New Features and Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
PowerCenter 7.1.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
PowerCenter 7.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii
PowerCenter 7.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
About Informatica Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxii
About this Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiii
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiii
Other Informatica Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiv
Visiting Informatica Customer Portal . . . . . . . . . . . . . . . . . . . . . . . . xxxiv
Visiting the Informatica Webzine . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiv
Visiting the Informatica Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiv
Visiting the Informatica Developer Network . . . . . . . . . . . . . . . . . . . xxxiv
Obtaining Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxv
Chapter 1: Aggregator Transformation . . . . . . . . . . . . . . . . . . . . . . . . 1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Ports in the Aggregator Transformation . . . . . . . . . . . . . . . . . . . . . . . . . 2
Components of the Aggregator Transformation . . . . . . . . . . . . . . . . . . . . 2
Aggregate Caches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Aggregate Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Aggregate Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Nested Aggregate Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Conditional Clauses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Non-Aggregate Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Null Values in Aggregate Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Group By Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Non-Aggregate Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Using Sorted Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
iii
Sorted Input Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Pre-Sorting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Creating an Aggregator Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Chapter 2: Custom Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Code Page Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Distributing Custom Transformation Procedures . . . . . . . . . . . . . . . . . . 19
Creating Custom Transformations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Rules and Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Custom Transformation Components . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Working with Groups and Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Creating Groups and Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Editing Groups and Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Defining Port Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Working with Port Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Custom Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Pipeline Partitioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Setting the Update Strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Working with Transaction Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Transformation Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Generate Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Working with Transaction Boundaries . . . . . . . . . . . . . . . . . . . . . . . . . 31
Blocking Input Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Writing the Procedure Code to Block Data . . . . . . . . . . . . . . . . . . . . . . 32
Configuring Custom Transformations as Blocking Transformations . . . . 32
Validating Mappings with Custom Transformations . . . . . . . . . . . . . . . . 33
Working with Procedure Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Creating Custom Transformation Procedures . . . . . . . . . . . . . . . . . . . . . . . . 36
Step 1. Create the Custom Transformation . . . . . . . . . . . . . . . . . . . . . . 36
Step 2. Generate the C Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Step 3. Fill Out the Code with the Transformation Logic . . . . . . . . . . . . 39
Step 4. Build the Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Step 5. Create a Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Step 6. Run the Session in a Workflow . . . . . . . . . . . . . . . . . . . . . . . . . 50
iv Table of Contents
Chapter 3: Custom Transformation Functions . . . . . . . . . . . . . . . . . 51
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Working with Handles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Function Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Working with Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Rules and Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Generated Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Initialization Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Notification Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Deinitialization Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Set Data Access Mode Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Navigation Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Property Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Rebind Datatype Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Data Handling Functions (Row-Based Mode) . . . . . . . . . . . . . . . . . . . . 78
Set Pass Through Port Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Output Notification Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Data Boundary Output Notification Function . . . . . . . . . . . . . . . . . . . 82
Error Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Session Log Message Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Increment Error Count Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Is Terminated Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Blocking Logic Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Pointer Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Change String Mode Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Set Data Code Page Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Row Strategy Functions (Row-Based Mode) . . . . . . . . . . . . . . . . . . . . . 89
Change Default Row Strategy Function . . . . . . . . . . . . . . . . . . . . . . . . 90
Array-Based API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Maximum Number of Rows Functions . . . . . . . . . . . . . . . . . . . . . . . . . 91
Number of Rows Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Is Row Valid Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Data Handling Functions (Array-Based Mode) . . . . . . . . . . . . . . . . . . . 93
Row Strategy Functions (Array-Based Mode) . . . . . . . . . . . . . . . . . . . . 96
Set Input Error Row Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Table of Contents v
Chapter 4: Expression Transformation . . . . . . . . . . . . . . . . . . . . . . . 99
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Calculating Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Adding Multiple Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Creating an Expression Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Chapter 5: External Procedure Transformation . . . . . . . . . . . . . . . . 103
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Code Page Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
External Procedures and External Procedure Transformations . . . . . . . . 105
External Procedure Transformation Properties . . . . . . . . . . . . . . . . . . . 105
Pipeline Partitioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
COM Versus Informatica External Procedures . . . . . . . . . . . . . . . . . . . 106
The BankSoft Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Developing COM Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Steps for Creating a COM Procedure . . . . . . . . . . . . . . . . . . . . . . . . . 107
COM External Procedure Server Type . . . . . . . . . . . . . . . . . . . . . . . . . 107
Using Visual C++ to Develop COM Procedures . . . . . . . . . . . . . . . . . . 107
Developing COM Procedures with Visual Basic . . . . . . . . . . . . . . . . . . 114
Developing Informatica External Procedures . . . . . . . . . . . . . . . . . . . . . . . 117
Step 1. Create the External Procedure Transformation . . . . . . . . . . . . . 117
Step 2. Generate the C++ Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Step 3. Fill Out the Method Stub with Implementation . . . . . . . . . . . . 122
Step 4. Building the Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Step 5. Create a Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Step 6. Run the Session in a Workflow . . . . . . . . . . . . . . . . . . . . . . . . 125
Distributing External Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Distributing COM Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Distributing Informatica Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Development Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
COM Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Row-Level Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Return Values from Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Exceptions in Procedure Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Memory Management for Procedures . . . . . . . . . . . . . . . . . . . . . . . . . 131
Wrapper Classes for Pre-Existing C/C++ Libraries or VB Functions . . . 131
Generating Error and Tracing Messages . . . . . . . . . . . . . . . . . . . . . . . . 131
vi Table of Contents
Unconnected External Procedure Transformations . . . . . . . . . . . . . . . . 133
Initializing COM and Informatica Modules . . . . . . . . . . . . . . . . . . . . 133
Other Files Distributed and Used in TX . . . . . . . . . . . . . . . . . . . . . . . 137
Server Variables Support in Initialization Properties . . . . . . . . . . . . . . . . . 138
External Procedure Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Dispatch Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
External Procedure Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Property Access Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Parameter Access Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Code Page Access Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Transformation Name Access Functions . . . . . . . . . . . . . . . . . . . . . . . 143
Procedure Access Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Partition Related Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Tracing Level Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Chapter 6: Filter Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Filter Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Creating a Filter Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Chapter 7: Joiner Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Joiner Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Defining a Join Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Defining the Join Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Normal Join . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Master Outer Join . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Detail Outer Join . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Full Outer Join . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Using Sorted Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Configuring the Sort Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Adding Transformations to the Mapping . . . . . . . . . . . . . . . . . . . . . . 164
Configuring the Joiner Transformation . . . . . . . . . . . . . . . . . . . . . . . . 164
Defining the Join Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Using Joiner Transformations in Mappings . . . . . . . . . . . . . . . . . . . . . . . . 167
Table of Contents vii
Joining Data from Multiple Sources . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Joining Data from the Same Source . . . . . . . . . . . . . . . . . . . . . . . . . . 167
PowerCenter Server Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Blocking the Source Pipelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Creating a Joiner Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Chapter 8: Lookup Transformation . . . . . . . . . . . . . . . . . . . . . . . . . 177
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Connected and Unconnected Lookups . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Connected Lookup Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Unconnected Lookup Transformation . . . . . . . . . . . . . . . . . . . . . . . . . 180
Relational and Flat File Lookups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Relational Lookups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Flat File Lookups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Lookup Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Lookup Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Lookup Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Lookup Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Lookup Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Metadata Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Lookup Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Configuring Lookup Properties in a Session . . . . . . . . . . . . . . . . . . . . 189
Lookup Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Default Lookup Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Overriding the Lookup Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Lookup Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Uncached or Static Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Dynamic Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Lookup Caches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Configuring Unconnected Lookup Transformations . . . . . . . . . . . . . . . . . . 200
Step 1. Add Input Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Step 2. Add the Lookup Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Step 3. Designate a Return Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Step 4. Call the Lookup Through an Expression . . . . . . . . . . . . . . . . . 202
Creating a Lookup Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
viii Table of Contents
Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Chapter 9: Lookup Caches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Cache Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Using a Persistent Lookup Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Using a Non-Persistent Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Using a Persistent Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Rebuilding the Lookup Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Working with an Uncached Lookup or Static Cache . . . . . . . . . . . . . . . . . 213
Working with a Dynamic Lookup Cache . . . . . . . . . . . . . . . . . . . . . . . . . 214
Using the NewLookupRow Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Using the Associated Input Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Working with Lookup Transformation Values . . . . . . . . . . . . . . . . . . . 218
Using the Ignore Null Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Using the Ignore in Comparison Property . . . . . . . . . . . . . . . . . . . . . . 222
Using Update Strategy Transformations with a Dynamic Cache . . . . . . 222
Updating the Dynamic Lookup Cache . . . . . . . . . . . . . . . . . . . . . . . . 224
Using the WHERE Clause with a Dynamic Cache . . . . . . . . . . . . . . . 226
Synchronizing the Dynamic Lookup Cache . . . . . . . . . . . . . . . . . . . . . 227
Example Using a Dynamic Lookup Cache . . . . . . . . . . . . . . . . . . . . . . 228
Rules and Guidelines for Dynamic Caches . . . . . . . . . . . . . . . . . . . . . 229
Sharing the Lookup Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Sharing an Unnamed Lookup Cache . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Sharing a Named Lookup Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Chapter 10: Normalizer Transformation . . . . . . . . . . . . . . . . . . . . . . 239
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Normalizing Data in a Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Normalizer Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Adding a COBOL Source to a Mapping . . . . . . . . . . . . . . . . . . . . . . . 242
Differences Between Normalizer Transformations . . . . . . . . . . . . . . . . . . . 246
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Chapter 11: Rank Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Table of Contents ix
Ranking String Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Rank Caches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Rank Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Ports in a Rank Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Rank Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Defining Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Creating a Rank Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Chapter 12: Router Transformation . . . . . . . . . . . . . . . . . . . . . . . . . 257
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Working with Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Input Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Output Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Using Group Filter Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Adding Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Working with Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Connecting Router Transformations in a Mapping . . . . . . . . . . . . . . . . . . . 266
Creating a Router Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Chapter 13: Sequence Generator Transformation . . . . . . . . . . . . . . 269
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Common Uses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Creating Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Replacing Missing Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Sequence Generator Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
NEXTVAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
CURRVAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Start Value and Cycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Increment By . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
End Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Current Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Number of Cached Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Creating a Sequence Generator Transformation . . . . . . . . . . . . . . . . . . . . . 280
x Table of Contents
Chapter 14: Sorter Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Sorting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Sorter Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Sorter Cache Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Case Sensitive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Work Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Distinct Output Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Tracing Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Null Treated Low . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Transformation Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Creating a Sorter Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Chapter 15: Source Qualifier Transformation . . . . . . . . . . . . . . . . . 293
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Transformation Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Target Load Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Parameters and Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Default Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Viewing the Default Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Overriding the Default Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Joining Source Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Default Join . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Custom Joins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Heterogeneous Joins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Creating Key Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Adding an SQL Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Entering a User-Defined Join . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Outer Join Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Informatica Join Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Creating an Outer Join . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Common Database Syntax Restrictions . . . . . . . . . . . . . . . . . . . . . . . . 314
Entering a Source Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Using Sorted Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Select Distinct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Overriding Select Distinct in the Session . . . . . . . . . . . . . . . . . . . . . . 319
Adding Pre- and Post-Session SQL Commands . . . . . . . . . . . . . . . . . . . . . 320
Table of Contents xi
Creating a Source Qualifier Transformation . . . . . . . . . . . . . . . . . . . . . . . . 321
Creating a Source Qualifier Transformation By Default . . . . . . . . . . . . 321
Creating a Source Qualifier Transformation Manually . . . . . . . . . . . . . 321
Configuring Source Qualifier Transformation Options . . . . . . . . . . . . . 321
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Chapter 16: Stored Procedure Transformation . . . . . . . . . . . . . . . . 325
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Input and Output Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Connected and Unconnected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Specifying when the Stored Procedure Runs . . . . . . . . . . . . . . . . . . . . 328
Stored Procedure Transformation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Writing a Stored Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Sample Stored Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Creating a Stored Procedure Transformation . . . . . . . . . . . . . . . . . . . . . . . 335
Importing Stored Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Manually Creating Stored Procedure Transformations . . . . . . . . . . . . . 337
Setting Options for the Stored Procedure . . . . . . . . . . . . . . . . . . . . . . 338
Using $Source and $Target Variables . . . . . . . . . . . . . . . . . . . . . . . . . 339
Changing the Stored Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Configuring a Connected Transformation . . . . . . . . . . . . . . . . . . . . . . . . . 341
Configuring an Unconnected Transformation . . . . . . . . . . . . . . . . . . . . . . 343
Calling a Stored Procedure From an Expression . . . . . . . . . . . . . . . . . . 343
Calling a Pre- or Post-Session Stored Procedure . . . . . . . . . . . . . . . . . . 346
Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Pre-Session Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Post-Session Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Session Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Supported Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
Expression Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Chapter 17: Transaction Control Transformation . . . . . . . . . . . . . . 357
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Transaction Control Transformation Properties . . . . . . . . . . . . . . . . . . . . . 359
Properties Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
xii Table of Contents
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Using Transaction Control Transformations in Mappings . . . . . . . . . . . . . . 363
Sample Transaction Control Mappings with Multiple Targets . . . . . . . 364
Mapping Guidelines and Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Creating a Transaction Control Transformation . . . . . . . . . . . . . . . . . . . . . 368
Chapter 18: Union Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Union Transformation Rules and Guidelines . . . . . . . . . . . . . . . . . . . . 370
Union Transformation Components . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Working with Groups and Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Creating a Union Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
Using a Union Transformation in Mappings . . . . . . . . . . . . . . . . . . . . . . . 375
Chapter 19: Update Strategy Transformation . . . . . . . . . . . . . . . . . 377
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Setting the Update Strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Flagging Rows Within a Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Forwarding Rejected Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Update Strategy Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Aggregator and Update Strategy Transformations . . . . . . . . . . . . . . . . 381
Lookup and Update Strategy Transformations . . . . . . . . . . . . . . . . . . . 382
Setting the Update Strategy for a Session . . . . . . . . . . . . . . . . . . . . . . . . . 383
Specifying an Operation for All Rows . . . . . . . . . . . . . . . . . . . . . . . . . 383
Specifying Operations for Individual Target Tables . . . . . . . . . . . . . . . 384
Update Strategy Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Chapter 20: XML Transformations . . . . . . . . . . . . . . . . . . . . . . . . . . 387
XML Source Qualifier Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
XML Parser Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
XML Generator Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Table of Contents xiii
xiv Table of Contents
List of Figures
Figure 1-1. Sample Mapping with Aggregator and Sorter Transformations . . . . . . . . . . . . . . . 10
Figure 2-1. Custom Transformation Ports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Figure 2-2. Editing Port Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Figure 2-3. Port Attribute Definitions Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Figure 2-4. Edit Port Attribute Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Figure 2-5. Custom Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Figure 2-6. Custom Transformation Ports Tab - Union Example . . . . . . . . . . . . . . . . . . . . . . 37
Figure 2-7. Custom Transformation Properties Tab - Union Example . . . . . . . . . . . . . . . . . . 38
Figure 2-8. Mapping with a Custom Transformation - Union Example . . . . . . . . . . . . . . . . . 50
Figure 3-1. Custom Transformation Handles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Figure 5-1. Process for Distributing External Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Figure 5-2. External Procedure Transformation Initialization Properties . . . . . . . . . . . . . . . . 136
Figure 5-3. External Procedure Transformation Initialization Properties Tab . . . . . . . . . . . . 138
Figure 6-1. Sample Mapping With a Filter Transformation . . . . . . . . . . . . . . . . . . . . . . . . . 148
Figure 6-2. Specifying a Filter Condition in a Filter Transformation . . . . . . . . . . . . . . . . . . 149
Figure 7-1. Sample Mapping with a Joiner Transformation . . . . . . . . . . . . . . . . . . . . . . . . . 156
Figure 7-2. The Joiner Transformation Properties Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Figure 7-3. A Mapping Configured to Join Data from Two Pipelines . . . . . . . . . . . . . . . . . . 166
Figure 7-4. Joining the Result Set with a Second Joiner Transformation . . . . . . . . . . . . . . . . 167
Figure 7-5. Mapping that Joins Two Branches of a Pipeline . . . . . . . . . . . . . . . . . . . . . . . . . 168
Figure 7-6. Mapping that Joins Two Instances of the Same Source . . . . . . . . . . . . . . . . . . . . 169
Figure 7-7. Mapping with Master and Detail Pipelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Figure 8-1. Session Properties for Flat File Lookups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Figure 8-2. Return Port in a Lookup Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Figure 9-1. Mapping With a Dynamic Lookup Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Figure 9-2. Dynamic Lookup Transformation Ports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Figure 9-3. Using Update Strategy Transformations with a Lookup Transformation . . . . . . . 223
Figure 9-4. Slowly Changing Dimension Mapping with Dynamic Lookup Cache . . . . . . . . . 228
Figure 10-1. COBOL Source Definition and a Normalizer Transformation . . . . . . . . . . . . . 243
Figure 11-1. Sample Mapping with a Rank Transformation . . . . . . . . . . . . . . . . . . . . . . . . . 250
Figure 12-1. Comparing Router and Filter Transformations . . . . . . . . . . . . . . . . . . . . . . . . 258
Figure 12-2. Sample Router Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Figure 12-3. Using a Router Transformation in a Mapping . . . . . . . . . . . . . . . . . . . . . . . . . 261
Figure 12-4. Specifying Group Filter Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Figure 12-5. Router Transformation Ports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Figure 12-6. Input Port Name and Corresponding Output Port Names . . . . . . . . . . . . . . . . 265
Figure 13-1. Connecting NEXTVAL to Two Target Tables in a Mapping . . . . . . . . . . . . . . . 272
Figure 13-2. Mapping With a Sequence Generator and an Expression Transformation . . . . . 273
Figure 13-3. Connecting CURRVAL and NEXTVAL Ports to a Target . . . . . . . . . . . . . . . . 274
Figure 14-1. Sample Mapping with a Sorter Transformation . . . . . . . . . . . . . . . . . . . . . . . . 284
List of Figures xv
Figure 14-2. Sample Sorter Transformation Ports Configuration . . . . . . . . . . . . . . . . . . . . . .285
Figure 14-3. Sorter Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .287
Figure 15-1. Source Definition Connected to a Source Qualifier Transformation . . . . . . . . . .297
Figure 15-2. Joining Two Tables With One Source Qualifier Transformation . . . . . . . . . . . . .300
Figure 15-3. Creating a Relationship Between Two Tables . . . . . . . . . . . . . . . . . . . . . . . . . .301
Figure 16-1. Sample Mapping With a Stored Procedure Transformation . . . . . . . . . . . . . . . .341
Figure 16-2. Expression Transformation Referencing a Stored Procedure Transformation . . . .343
Figure 16-3. Stored Procedure Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .349
Figure 17-1. Transaction Control Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . .360
Figure 17-2. Sample Transaction Control Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .362
Figure 17-3. Effective and Ineffective Transaction Control Transformations . . . . . . . . . . . . . .364
Figure 17-4. Transaction Control Transformation Effective for a Transformation . . . . . . . . . .364
Figure 17-5. Valid Mapping with Transaction Control Transformations . . . . . . . . . . . . . . . . .365
Figure 17-6. Invalid Mapping with Transaction Control Transformations . . . . . . . . . . . . . . .366
Figure 18-1. Union Transformation Groups Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .371
Figure 18-2. Union Transformation Group Ports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .372
Figure 18-3. Union Transformation Ports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .372
Figure 18-4. Mapping with a Union Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .375
Figure 19-1. Specifying Operations for Individual Target Tables . . . . . . . . . . . . . . . . . . . . . .385
xvi List of Figures
List of Tables
Table 2-1. Custom Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Table 2-2. Transaction Boundary Handling with Custom Transformations . . . . . . . . . . . . . . . 31
Table 2-3. Module File Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Table 2-4. UNIX Commands for Building the Shared Library . . . . . . . . . . . . . . . . . . . . . . . . . 49
Table 3-1. Custom Transformation Handles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Table 3-2. Custom Transformation Generated Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 3-3. Custom Transformation API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 3-4. Custom Transformation Array-Based API Functions . . . . . . . . . . . . . . . . . . . . . . . 56
Table 3-5. Handle Property IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Table 3-6. Property Functions (MBCS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Table 3-7. Property Functions (Unicode). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Table 3-8. Compatible Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Table 3-9. Get Data Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Table 3-10. Get Data Functions (Array-Based Mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Table 5-1. Differences Between COM and Informatica External Procedures . . . . . . . . . . . . . 106
Table 5-2. Visual C++ and Transformation Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Table 5-3. Visual Basic and Transformation Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Table 5-4. External Procedure Initialization Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Table 5-5. Descriptions of Parameter Access Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Table 5-6. Member Variable of the External Procedure Base Class. . . . . . . . . . . . . . . . . . . . . 143
Table 7-1. Joiner Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Table 8-1. Differences Between Connected and Unconnected Lookups . . . . . . . . . . . . . . . . . 179
Table 8-2. Lookup Transformation Port Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Table 8-3. Lookup Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Table 8-4. Session Properties for Flat File Lookups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Table 9-1. Lookup Caching Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Table 9-2. PowerCenter Server Handling of Persistent Caches . . . . . . . . . . . . . . . . . . . . . . . 210
Table 9-3. NewLookupRow Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Table 9-4. Dynamic Lookup Cache Behavior for Insert Row Type . . . . . . . . . . . . . . . . . . . . 225
Table 9-5. Dynamic Lookup Cache Behavior for Update Row Type . . . . . . . . . . . . . . . . . . . 225
Table 9-6. Location for Sharing Unnamed Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Table 9-7. Properties for Named Shared Lookup Transformations. . . . . . . . . . . . . . . . . . . . . 231
Table 9-8. Location for Sharing Named Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Table 9-9. Properties for Named Shared Lookup Transformations. . . . . . . . . . . . . . . . . . . . . 234
Table 10-1. VSAM and Relational Normalizer Transformation Differences . . . . . . . . . . . . . . 246
Table 11-1. Rank Transformation Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Table 13-1. Sequence Generator Transformation Properties . . . . . . . . . . . . . . . . . . . . . . . . . 275
Table 14-1. Column Sizes for Sorter Data Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Table 15-1. Conversion for Datetime Mapping Parameters and Variables . . . . . . . . . . . . . . . 295
Table 15-2. Locations for Entering Outer Join Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
List of Tables xvii
Table 15-3. Syntax for Normal Joins in a Join Override . . . . . . . . . . . . . . . . . . . . . . . . . . . . .308
Table 15-4. Syntax for Left Outer Joins in a Join Override . . . . . . . . . . . . . . . . . . . . . . . . . . .310
Table 15-5. Syntax for Right Outer Joins in a Join Override . . . . . . . . . . . . . . . . . . . . . . . . .312
Table 16-1. Comparison of Connected and Unconnected Stored Procedure Transformations . .328
Table 16-2. Setting Options for the Stored Procedure Transformation . . . . . . . . . . . . . . . . . .338
Table 19-1. Constants for Each Database Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .380
Table 19-2. Specifying an Operation for All Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .383
Table 19-3. Update Strategy Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .384
xviii List of Tables
Preface
Welcome to PowerCenter, Informatica’s software product that delivers an open, scalable data
integration solution addressing the complete life cycle for all data integration projects
including data warehouses and data marts, data migration, data synchronization, and
information hubs. PowerCenter combines the latest technology enhancements for reliably
managing data repositories and delivering information resources in a timely, usable, and
efficient manner.
The PowerCenter metadata repository coordinates and drives a variety of core functions,
including extracting, transforming, loading, and managing data. The PowerCenter Server can
extract large volumes of data from multiple platforms, handle complex transformations on the
data, and support high-speed loads. PowerCenter can simplify and accelerate the process of
moving data warehouses from development to test to production.
xix
New Features and Enhancements
This section describes new features and enhancements to PowerCenter 7.1.1, 7.1, and 7.0.
PowerCenter 7.1.1
This section describes new features and enhancements to PowerCenter 7.1.1.
Data Profiling
♦ Data sampling. You can create a data profile for a sample of source data instead of the
entire source. You can view a profile from a random sample of data, a specified percentage
of data, or for a specified number of rows starting with the first row.
♦ Verbose data enhancements. You can specify the type of verbose data you want the
PowerCenter Server to write to the Data Profiling warehouse. The PowerCenter Server can
write all rows, the rows that meet the business rule, or the rows that do not meet the
business rule.
♦ Session enhancement. You can save sessions that you create from the Profile Manager to
the repository.
♦ Domain Inference function tuning. You can configure the Data Profiling Wizard to filter
the Domain Inference function results. You can configure a maximum number of patterns
and a minimum pattern frequency. You may want to narrow the scope of patterns returned
to view only the primary domains, or you may want to widen the scope of patterns
returned to view exception data.
♦ Row Uniqueness function. You can determine unique rows for a source based on a
selection of columns for the specified source.
♦ Define mapping, session, and workflow prefixes. You can define default mapping,
session, and workflow prefixes for the mappings, sessions, and workflows generated when
you create a data profile.
♦ Profile mapping display in the Designer. The Designer displays profile mappings under a
profile mappings node in the Navigator.
PowerCenter Server
♦ Code page. PowerCenter supports additional Japanese language code pages, such as JIPSE-
kana, JEF-kana, and MELCOM-kana.
♦ Flat file partitioning. When you create multiple partitions for a flat file source session, you
can configure the session to create multiple threads to read the flat file source.
♦ pmcmd. You can use parameter files that reside on a local machine with the Startworkflow
command in the pmcmd program. When you use a local parameter file, pmcmd passes
variables and values in the file to the PowerCenter Server.
xx Preface
♦ SuSE Linux support. The PowerCenter Server runs on SuSE Linux. On SuSE Linux, you
can connect to IBM, DB2, Oracle, and Sybase sources, targets, and repositories using
native drivers. Use ODBC drivers to access other sources and targets.
♦ Reserved word support. If or column name contains a database reserved word, you can
create and maintain a file, reswords.txt, containing reserved words. When the PowerCenter
Server initializes a session, it searches for reswords.txt in the PowerCenter Server
installation directory. If the file exists, the PowerCenter Server places quotes around
matching reserved words when it executes SQL against the database.
♦ Teradata external loader. When you load to Teradata using an external loader, you can
now override the control file. Depending on the loader you use, you can also override the
error, log, and work table names by specifying different tables on the same or different
Teradata database.
Repository
♦ Exchange metadata with other tools. You can exchange source and target metadata with
other BI or data modeling tools, such as Business Objects Designer. You can export or
import multiple objects at a time. When you export metadata, the PowerCenter Client
creates a file format recognized by the target tool.
Repository Server
♦ pmrep. You can use pmrep to perform the following functions:
− Remove repositories from the Repository Server cache entry list.
− Enable enhanced security when you create a relational source or target connection in the
repository.
− Update a connection attribute value when you update the connection.
♦ SuSE Linux support. The Repository Server runs on SuSE Linux. On SuSE Linux, you
can connect to IBM, DB2, Oracle, and Sybase repositories.
Security
♦ Oracle OS Authentication. You can now use Oracle OS Authentication to authenticate
database users. Oracle OS Authentication allows you to log on to an Oracle database if you
have a logon to the operating system. You do not need to know a database user name and
password. PowerCenter uses Oracle OS Authentication when the user name for an Oracle
connection is PmNullUser.
Web Services Provider
♦ Attachment support. When you import web service definitions with attachment groups,
you can pass attachments through the requests or responses in a service session. The
document type you can attach is based on the mime content of the WSDL file. You can
attach document types such as XML, JPEG, GIF, or PDF.
Preface xxi
♦ Pipeline partitioning. You can create multiple partitions in a session containing web
service source and target definitions. The PowerCenter Server creates a connection to the
Web Services Hub based on the number of sources, targets, and partitions in the session.
XML
♦ Multi-level pivoting. You can now pivot more than one multiple-occurring element in an
XML view. You can also pivot the view row.
PowerCenter 7.1
This section describes new features and enhancements to PowerCenter 7.1.
Data Profiling
♦ Data Profiling for VSAM sources. You can now create a data profile for VSAM sources.
♦ Support for verbose mode for source-level functions. You can now create data profiles
with source-level functions and write data to the Data Profiling warehouse in verbose
mode.
♦ Aggregator function in auto profiles. Auto profiles now include the Aggregator function.
♦ Creating auto profile enhancements. You can now select the columns or groups you want
to include in an auto profile and enable verbose mode for the Distinct Value Count
function.
♦ Purging data from the Data Profiling warehouse. You can now purge data from the Data
Profiling warehouse.
♦ Source View in the Profile Manager. You can now view data profiles by source definition
in the Profile Manager.
♦ PowerCenter Data Profiling report enhancements. You can now view PowerCenter Data
Profiling reports in a separate browser window, resize columns in a report, and view
verbose data for Distinct Value Count functions.
♦ Prepackaged domains. Informatica provides a set of prepackaged domains that you can
include in a Domain Validation function in a data profile.
Documentation
♦ Web Services Provider Guide. This is a new book that describes the functionality of Real-time
Web Services. It also includes information from the version 7.0 Web Services Hub Guide.
♦ XML User Guide. This book consolidates XML information previously documented in the
Designer Guide, Workflow Administration Guide, and Transformation Guide.
Licensing
Informatica provides licenses for each CPU and each repository rather than for each
installation. Informatica provides licenses for product, connectivity, and options. You store
xxii Preface
the license keys in a license key file. You can manage the license files using the Repository
Server Administration Console, the PowerCenter Server Setup, and the command line
program, pmlic.
PowerCenter Server
♦ 64-bit support. You can now run 64-bit PowerCenter Servers on AIX and HP-UX
(Itanium).
♦ Partitioning enhancements. If you have the Partitioning option, you can define up to 64
partitions at any partition point in a pipeline that supports multiple partitions.
♦ PowerCenter Server processing enhancements. The PowerCenter Server now reads a
block of rows at a time. This improves processing performance for most sessions.
♦ CLOB/BLOB datatype support. You can now read and write CLOB/BLOB datatypes.
PowerCenter Metadata Reporter
PowerCenter Metadata Reporter modified some report names and uses the PowerCenter 7.1
MX views in its schema.
Repository Server
♦ Updating repository statistics. PowerCenter now identifies and updates statistics for all
repository tables and indexes when you copy, upgrade, and restore repositories. This
improves performance when PowerCenter accesses the repository.
♦ Increased repository performance. You can increase repository performance by skipping
information when you copy, back up, or restore a repository. You can choose to skip MX
data, workflow and session log history, and deploy group history.
♦ pmrep. You can use pmrep to back up, disable, or enable a repository, delete a relational
connection from a repository, delete repository details, truncate log files, and run multiple
pmrep commands sequentially. You can also use pmrep to create, modify, and delete a
folder.
Repository
♦ Exchange metadata with business intelligence tools. You can export metadata to and
import metadata from other business intelligence tools, such as Cognos Report Net and
Business Objects.
♦ Object import and export enhancements. You can compare objects in an XML file to
objects in the target repository when you import objects.
♦ MX views. MX views have been added to help you analyze metadata stored in the
repository. REP_SERVER_NET and REP_SERVER_NET_REF views allow you to see
information about server grids. REP_VERSION_PROPS allows you to see the version
history of all objects in a PowerCenter repository.
Preface xxiii
Transformations
♦ Flat file lookup. You can now perform lookups on flat files. When you create a Lookup
transformation using a flat file as a lookup source, the Designer invokes the Flat File
Wizard. You can also use a lookup file parameter if you want to change the name or
location of a lookup between session runs.
♦ Dynamic lookup cache enhancements. When you use a dynamic lookup cache, the
PowerCenter Server can ignore some ports when it compares values in lookup and input
ports before it updates a row in the cache. Also, you can choose whether the PowerCenter
Server outputs old or new values from the lookup/output ports when it updates a row. You
might want to output old values from lookup/output ports when you use the Lookup
transformation in a mapping that updates slowly changing dimension tables.
♦ Union transformation. You can use the Union transformation to merge multiple sources
into a single pipeline. The Union transformation is similar to using the UNION ALL SQL
statement to combine the results from two or more SQL statements.
♦ Custom transformation API enhancements. The Custom transformation API includes
new array-based functions that allow you to create procedure code that receives and
outputs a block of rows at a time. Use these functions to take advantage of the
PowerCenter Server processing enhancements.
♦ Midstream XML transformations. You can now create an XML Parser transformation or
an XML Generator transformation to parse or generate XML inside a pipeline. The XML
transformations enable you to extract XML data stored in relational tables, such as data
stored in a CLOB column. You can also extract data from messaging systems, such as
TIBCO or IBM MQSeries.
Usability
♦ Viewing active folders. The Designer and the Workflow Manager highlight the active
folder in the Navigator.
♦ Enhanced printing. The quality of printed workspace has improved.
Version Control
You can run object queries that return shortcut objects. You can also run object queries based
on the latest status of an object. The query can return local objects that are checked out, the
latest version of checked in objects, or a collection of all older versions of objects.
Web Services Provider
♦ Real-time Web Services. Real-time Web Services allows you to create services using the
Workflow Manager and make them available to web service clients through the Web
Services Hub. The PowerCenter Server can perform parallel processing of both request-
response and one-way services.
♦ Web Services Hub. The Web Services Hub now hosts Real-time Web Services in addition
to Metadata Web Services and Batch Web Services. You can install the Web Services Hub
on a JBoss application server.
xxiv Preface
Note: PowerCenter Connect for Web Services allows you to create sources, targets, and
transformations to call web services hosted by other providers. For more informations, see
PowerCenter Connect for Web Services User and Administrator Guide.
Workflow Monitor
The Workflow Monitor includes the following performance and usability enhancements:
♦ When you connect to the PowerCenter Server, you no longer distinguish between online
or offline mode.
♦ You can open multiple instances of the Workflow Monitor on one machine.
♦ You can simultaneously monitor multiple PowerCenter Servers registered to the same
repository.
♦ The Workflow Monitor includes improved options for filtering tasks by start and end
time.
♦ The Workflow Monitor displays workflow runs in Task view chronologically with the most
recent run at the top. It displays folders alphabetically.
♦ You can remove the Navigator and Output window.
XML Support
PowerCenter XML support now includes the following features:
♦ Enhanced datatype support. You can use XML schemas that contain simple and complex
datatypes.
♦ Additional options for XML definitions. When you import XML definitions, you can
choose how you want the Designer to represent the metadata associated with the imported
files. You can choose to generate XML views using hierarchy or entity relationships. In a
view with hierarchy relationships, the Designer expands each element and reference under
its parent element. When you create views with entity relationships, the Designer creates
separate entities for references and multiple-occurring elements.
♦ Synchronizing XML definitions. You can synchronize one or more XML definition when
the underlying schema changes. You can synchronize an XML definition with any
repository definition or file used to create the XML definition, including relational sources
or targets, XML files, DTD files, or schema files.
♦ XML workspace. You can edit XML views and relationships between views in the
workspace. You can create views, add or delete columns from views, and define
relationships between views.
♦ Midstream XML transformations. You can now create an XML Parser transformation or
an XML Generator transformation to parse or generate XML inside a pipeline. The XML
transformations enable you to extract XML data stored in relational tables, such as data
stored in a CLOB column. You can also extract data from messaging systems, such as
TIBCO or IBM MQSeries.
Preface xxv
♦ Support for circular references. Circular references occur when an element is a direct or
indirect child of itself. PowerCenter now supports XML files, DTD files, and XML
schemas that use circular definitions.
♦ Increased performance for large XML targets. You can create XML files of several
gigabytes in a PowerCenter 7.1 XML session by using the following enhancements:
− Spill to disk. You can specify the size of the cache used to store the XML tree. If the size
of the tree exceeds the cache size, the XML data spills to disk in order to free up
memory.
− User-defined commits. You can define commits to trigger flushes for XML target files.
− Support for multiple XML output files. You can output XML data to multiple XML
targets. You can also define the file names for XML output files in the mapping.
PowerCenter 7.0
This section describes new features and enhancements to PowerCenter 7.0.
Data Profiling
If you have the Data Profiling option, you can profile source data to evaluate source data and
detect patterns and exceptions. For example, you can determine implicit data type, suggest
candidate keys, detect data patterns, and evaluate join criteria. After you create a profiling
warehouse, you can create profiling mappings and run sessions. Then you can view reports
based on the profile data in the profiling warehouse.
The PowerCenter Client provides a Profile Manager and a Profile Wizard to complete these
tasks.
Data Integration Web Services
You can use Data Integration Web Services to write applications to communicate with the
PowerCenter Server. Data Integration Web Services is a web-enabled version of the
PowerCenter Server functionality available through Load Manager and Metadata Exchange. It
is comprised of two services for communication with the PowerCenter Server, Load Manager
and Metadata Exchange Web Services running on the Web Services Hub.
Documentation
♦ Glossary. The Installation and Configuration Guide contains a glossary of new PowerCenter
terms.
♦ Installation and Configuration Guide. The connectivity information in the Installation
and Configuration Guide is consolidated into two chapters. This book now contains
chapters titled “Connecting to Databases from Windows” and “Connecting to Databases
from UNIX.”
♦ Upgrading metadata. The Installation and Configuration Guide now contains a chapter
titled “Upgrading Repository Metadata.” This chapter describes changes to repository
xxvi Preface
objects impacted by the upgrade process. The change in functionality for existing objects
depends on the version of the existing objects. Consult the upgrade information in this
chapter for each upgraded object to determine whether the upgrade applies to your current
version of PowerCenter.
Functions
♦ Soundex. The Soundex function encodes a string value into a four-character string.
SOUNDEX works for characters in the English alphabet (A-Z). It uses the first character
of the input string as the first character in the return value and encodes the remaining
three unique consonants as numbers.
♦ Metaphone. The Metaphone function encodes string values. You can specify the length of
the string that you want to encode. METAPHONE encodes characters of the English
language alphabet (A-Z). It encodes both uppercase and lowercase letters in uppercase.
Installation
♦ Remote PowerCenter Client installation. You can create a control file containing
installation information, and distribute it to other users to install the PowerCenter Client.
You access the Informatica installation CD from the command line to create the control
file and install the product.
PowerCenter Metadata Reporter
PowerCenter Metadata Reporter replaces Runtime Metadata Reporter and Informatica
Metadata Reporter. PowerCenter Metadata Reporter includes the following features:
♦ Metadata browsing. You can use PowerCenter Metadata Reporter to browse PowerCenter
7.0 metadata, such as workflows, worklets, mappings, source and target tables, and
transformations.
♦ Metadata analysis. You can use PowerCenter Metadata Reporter to analyze operational
metadata, including session load time, server load, session completion status, session
errors, and warehouse growth.
PowerCenter Server
♦ DB2 bulk loading. You can enable bulk loading when you load to IBM DB2 8.1.
♦ Distributed processing. If you purchase the Server Grid option, you can group
PowerCenter Servers registered to the same repository into a server grid. In a server grid,
PowerCenter Servers balance the workload among all the servers in the grid.
♦ Row error logging. The session configuration object has new properties that allow you to
define error logging. You can choose to log row errors in a central location to help
understand the cause and source of errors.
♦ External loading enhancements. When using external loaders on Windows, you can now
choose to load from a named pipe. When using external loaders on UNIX, you can now
choose to load from staged files.
Preface xxvii
♦ External loading using Teradata Warehouse Builder. You can use Teradata Warehouse
Builder to load to Teradata. You can choose to insert, update, upsert, or delete data.
Additionally, Teradata Warehouse Builder can simultaneously read from multiple sources
and load data into one or more tables.
♦ Mixed mode processing for Teradata external loaders. You can now use data driven load
mode with Teradata external loaders. When you select data driven loading, the
PowerCenter Server flags rows for insert, delete, or update. It writes a column in the target
file or named pipe to indicate the update strategy. The control file uses these values to
determine how to load data to the target.
♦ Concurrent processing. The PowerCenter Server now reads data concurrently from
sources within a target load order group. This enables more efficient joins with minimal
usage of memory and disk cache.
♦ Real time processing enhancements. You can now use real-time processing in sessions that
also process active transformations, such as the Aggregator transformation. You can apply
the transformation logic to rows defined by transaction boundaries.
Repository Server
♦ Object export and import enhancements. You can now export and import objects using
the Repository Manager and pmrep. You can export and import multiple objects and
objects types. You can export and import objects with or without their dependent objects.
You can also export objects from a query result or objects history.
♦ pmrep commands. You can use pmrep to perform change management tasks, such as
maintaining deployment groups and labels, checking in, deploying, importing, exporting,
and listing objects. You can also use pmrep to run queries. The deployment and object
import commands require you to use a control file to define options and resolve conflicts.
♦ Trusted connections. You can now use a Microsoft SQL Server trusted connection to
connect to the repository.
Security
♦ LDAP user authentication. You can now use default repository user authentication or
Lightweight Directory Access Protocol (LDAP) to authenticate users. If you use LDAP, the
repository maintains an association between your repository user name and your external
login name. When you log in to the repository, the security module passes your login name
to the external directory for authentication. The repository maintains a status for each
user. You can now enable or disable users from accessing the repository by changing the
status. You do not have to delete user names from the repository.
♦ Use Repository Manager privilege. The Use Repository Manager privilege allows you to
perform tasks in the Repository Manager, such as copy object, maintain labels, and change
object status. You can perform the same tasks in the Designer and Workflow Manager if
you have the Use Designer and Use Workflow Manager privileges.
♦ Audit trail. You can track changes to repository users, groups, privileges, and permissions
through the Repository Server Administration Console. The Repository Agent logs
security changes to a log file stored in the Repository Server installation directory. The
xxviii Preface
audit trail log contains information, such as changes to folder properties, adding or
removing a user or group, and adding or removing privileges.
Transformations
♦ Custom transformation. Custom transformations operate in conjunction with procedures
you create outside of the Designer interface to extend PowerCenter functionality. The
Custom transformation replaces the Advanced External Procedure transformation. You can
create Custom transformations with multiple input and output groups, and you can
compile the procedure with any C compiler.
You can create templates that customize the appearance and available properties of a
Custom transformation you develop. You can specify the icons used for transformation,
the colors, and the properties a mapping developer can modify. When you create a Custom
transformation template, distribute the template with the DLL or shared library you
develop.
♦ Joiner transformation. You can use the Joiner transformation to join two data streams that
originate from the same source.
Version Control
The PowerCenter Client and repository introduce features that allow you to create and
manage multiple versions of objects in the repository. Version control allows you to maintain
multiple versions of an object, control development on the object, track changes, and use
deployment groups to copy specific groups of objects from one repository to another. Version
control in PowerCenter includes the following features:
♦ Object versioning. Individual objects in the repository are now versioned. This allows you
to store multiple copies of a given object during the development cycle. Each version is a
separate object with unique properties.
♦ Check out and check in versioned objects. You can check out and reserve an object you
want to edit, and check in the object when you are ready to create a new version of the
object in the repository.
♦ Compare objects. The Repository Manager and Workflow Manager allow you to compare
two repository objects of the same type to identify differences between them. You can
compare Designer objects and Workflow Manager objects in the Repository Manager. You
can compare tasks, sessions, worklets, and workflows in the Workflow Manager. The
PowerCenter Client tools allow you to compare objects across open folders and
repositories. You can also compare different versions of the same object.
♦ Delete or purge a version. You can delete an object from view and continue to store it in
the repository. You can recover or undelete deleted objects. If you want to permanently
remove an object version, you can purge it from the repository.
♦ Deployment. Unlike copying a folder, copying a deployment group allows you to copy a
select number of objects from multiple folders in the source repository to multiple folders
in the target repository. This gives you greater control over the specific objects copied from
one repository to another.
Preface xxix
♦ Deployment groups. You can create a deployment group that contains references to
objects from multiple folders across the repository. You can create a static deployment
group that you manually add objects to, or create a dynamic deployment group that uses a
query to populate the group.
♦ Labels. A label is an object that you can apply to versioned objects in the repository. This
allows you to associate multiple objects in groups defined by the label. You can use labels
to track versioned objects during development, improve query results, and organize groups
of objects for deployment or export and import.
♦ Queries. You can create a query that specifies conditions to search for objects in the
repository. You can save queries for later use. You can make a private query, or you can
share it with all users in the repository.
♦ Track changes to an object. You can view a history that includes all versions of an object
and compare any version of the object in the history to any other version. This allows you
to see the changes made to an object over time.
XML Support
PowerCenter contains XML features that allow you to validate an XML file against an XML
schema, declare multiple namespaces, use XPath to locate XML nodes, increase performance
for large XML files, format your XML file output for increased readability, and parse or
generate XML data from various sources. XML support in PowerCenter includes the
following features:
♦ XML schema. You can use an XML schema to validate an XML file and to generate source
and target definitions. XML schemas allow you to declare multiple namespaces so you can
use prefixes for elements and attributes. XML schemas also allow you to define some
complex datatypes.
♦ XPath support. The XML wizard allows you to view the structure of XML schema. You
can use XPath to locate XML nodes.
♦ Increased performance for large XML files. When you process an XML file or stream, you
can set commits and periodically flush XML data to the target instead of writing all the
output at the end of the session. You can choose to append the data to the same target file
or create a new target file after each flush.
♦ XML target enhancements. You can format the XML target file so that you can easily view
the XML file in a text editor. You can also configure the PowerCenter Server to not output
empty elements to the XML target.
Usability
♦ Copying objects. You can now copy objects from all the PowerCenter Client tools using
the copy wizard to resolve conflicts. You can copy objects within folders, to other folders,
and to different repositories. Within the Designer, you can also copy segments of
mappings to a workspace in a new folder or repository.
♦ Comparing objects. You can compare workflows and tasks from the Workflow Manager.
You can also compare all objects from within the Repository Manager.
xxx Preface
♦ Change propagation. When you edit a port in a mapping, you can choose to propagate
changed attributes throughout the mapping. The Designer propagates ports, expressions,
and conditions based on the direction that you propagate and the attributes you choose to
propagate.
♦ Enhanced partitioning interface. The Session Wizard is enhanced to provide a graphical
depiction of a mapping when you configure partitioning.
♦ Revert to saved. You can now revert to the last saved version of an object in the Workflow
Manager. When you do this, the Workflow Manager accesses the repository to retrieve the
last-saved version of the object.
♦ Enhanced validation messages. The PowerCenter Client writes messages in the Output
window that describe why it invalidates a mapping or workflow when you modify a
dependent object.
♦ Validate multiple objects. You can validate multiple objects in the repository without
fetching them into the workspace. You can save and optionally check in objects that
change from invalid to valid status as a result of the validation. You can validate sessions,
mappings, mapplets, workflows, and worklets.
♦ View dependencies. Before you edit or delete versioned objects, such as sources, targets,
mappings, or workflows, you can view dependencies to see the impact on other objects.
You can view parent and child dependencies and global shortcuts across repositories.
Viewing dependencies help you modify objects and composite objects without breaking
dependencies.
♦ Refresh session mappings. In the Workflow Manager, you can refresh a session mapping.
Preface xxxi
About Informatica Documentation
The complete set of documentation for PowerCenter includes the following books:
♦ Data Profiling Guide. Provides information about how to profile PowerCenter sources to
evaluate source data and detect patterns and exceptions.
♦ Designer Guide. Provides information needed to use the Designer. Includes information to
help you create mappings, mapplets, and transformations. Also includes a description of
the transformation datatypes used to process and transform source data.
♦ Getting Started. Provides basic tutorials for getting started.
♦ Installation and Configuration Guide. Provides information needed to install and
configure the PowerCenter tools, including details on environment variables and database
connections.
♦ PowerCenter Connect® for JMS® User and Administrator Guide. Provides information
to install PowerCenter Connect for JMS, build mappings, extract data from JMS messages,
and load data into JMS messages.
♦ Repository Guide. Provides information needed to administer the repository using the
Repository Manager or the pmrep command line program. Includes details on
functionality available in the Repository Manager and Administration Console, such as
creating and maintaining repositories, folders, users, groups, and permissions and
privileges.
♦ Transformation Language Reference. Provides syntax descriptions and examples for each
transformation function provided with PowerCenter.
♦ Transformation Guide. Provides information on how to create and configure each type of
transformation in the Designer.
♦ Troubleshooting Guide. Lists error messages that you might encounter while using
PowerCenter. Each error message includes one or more possible causes and actions that
you can take to correct the condition.
♦ Web Services Provider Guide. Provides information you need to install and configure the Web
Services Hub. This guide also provides information about how to use the web services that the
Web Services Hub hosts. The Web Services Hub hosts Real-time Web Services, Batch Web
Services, and Metadata Web Services.
♦ Workflow Administration Guide. Provides information to help you create and run
workflows in the Workflow Manager, as well as monitor workflows in the Workflow
Monitor. Also contains information on administering the PowerCenter Server and
performance tuning.
♦ XML User Guide. Provides information you need to create XML definitions from XML,
XSD, or DTD files, and relational or other XML definitions. Includes information on
running sessions with XML data. Also includes details on using the midstream XML
transformations to parse or generate XML data within a pipeline.
xxxii Preface
About this Book
The Transformation Guide is written for the IS developers and software engineers responsible
for implementing your data warehouse. The Transformation Guide assumes that you have a
solid understanding of your operating systems, relational database concepts, and the database
engines, flat files, or mainframe system in your environment. This guide also assumes that
you are familiar with the interface requirements for your supporting applications.
The material in this book is available for online use.
Document Conventions
This guide uses the following formatting conventions:
If you see… It means…
italicized text The word or set of words are especially emphasized.
boldfaced text Emphasized subjects.
italicized monospaced text This is the variable name for a value you enter as part of an
operating system command. This is generic text that should be
replaced with user-supplied values.
Note: The following paragraph provides additional facts.
Tip: The following paragraph provides suggested uses.
Warning: The following paragraph notes situations where you can overwrite
or corrupt data, unless you follow the specified procedure.
monospaced text This is a code example.
bold monospaced text This is an operating system command you enter from a prompt to
run a task.
Preface xxxiii
Other Informatica Resources
In addition to the product manuals, Informatica provides these other resources:
♦ Informatica Customer Portal
♦ Informatica Webzine
♦ Informatica web site
♦ Informatica Developer Network
♦ Informatica Technical Support
Visiting Informatica Customer Portal
As an Informatica customer, you can access the Informatica Customer Portal site at http://
my.informatica.com. The site contains product information, user group information,
newsletters, access to the Informatica customer support case management system (ATLAS),
the Informatica Knowledgebase, Informatica Webzine, and access to the Informatica user
community.
Visiting the Informatica Webzine
The Informatica Documentation team delivers an online journal, the Informatica Webzine.
This journal provides solutions to common tasks, detailed descriptions of specific features,
and tips and tricks to help you develop data warehouses.
The Informatica Webzine is a password-protected site that you can access through the
Customer Portal. The Customer Portal has an online registration form for login accounts to
its webzine and web support. To register for an account, go to http://my.informatica.com.
If you have any questions, please email webzine@informatica.com.
Visiting the Informatica Web Site
You can access Informatica’s corporate web site at http://www.informatica.com. The site
contains information about Informatica, its background, upcoming events, and locating your
closest sales office. You will also find product information, as well as literature and partner
information. The services area of the site includes important information on technical
support, training and education, and implementation services.
Visiting the Informatica Developer Network
The Informatica Developer Network is a web-based forum for third-party software
developers. You can access the Informatica Developer Network at the following URL:
http://devnet.informatica.com
xxxiv Preface
The site contains information on how to create, market, and support customer-oriented add-
on solutions based on Informatica’s interoperability interfaces.
Obtaining Technical Support
There are many ways to access Informatica technical support. You can call or email your
nearest Technical Support Center listed below or you can use our WebSupport Service.
WebSupport requires a user name and password. You can request a user name and password at
http://my.informatica.com.
North America / South America Africa / Asia / Australia / Europe
Informatica Corporation Informatica Software Ltd.
2100 Seaport Blvd. 6 Waltham Park
Redwood City, CA 94063 Waltham Road, White Waltham
Phone: 866.563.6332 or 650.385.5800 Maidenhead, Berkshire
Fax: 650.213.9489 SL6 3TN
Hours: 6 a.m. - 6 p.m. (PST/PDT) Phone: 44 870 606 1525
email: support@informatica.com Fax: +44 1628 511 411
Hours: 9 a.m. - 5:30 p.m. (GMT)
email: support_eu@informatica.com
Belgium
Phone: +32 15 281 702
Hours: 9 a.m. - 5:30 p.m. (local time)
France
Phone: +33 1 41 38 92 26
Hours: 9 a.m. - 5:30 p.m. (local time)
Germany
Phone: +49 1805 702 702
Hours: 9 a.m. - 5:30 p.m. (local time)
Netherlands
Phone: +31 306 082 089
Hours: 9 a.m. - 5:30 p.m. (local time)
Singapore
Phone: +65 322 8589
Hours: 9 a.m. - 5 p.m. (local time)
Switzerland
Phone: +41 800 81 80 70
Hours: 8 a.m. - 5 p.m. (local time)
Preface xxxv
xxxvi Preface
Chapter 1
Aggregator
Transformation
This chapter covers the following topics:
♦ Overview, 2
♦ Aggregate Expressions, 4
♦ Group By Ports, 6
♦ Using Sorted Input, 9
♦ Creating an Aggregator Transformation, 11
♦ Tips, 14
♦ Troubleshooting, 15
1
Overview
Transformation type:
Connected
Active
The Aggregator transformation allows you to perform aggregate calculations, such as averages
and sums. The Aggregator transformation is unlike the Expression transformation, in that you
can use the Aggregator transformation to perform calculations on groups. The Expression
transformation permits you to perform calculations on a row-by-row basis only.
When using the transformation language to create aggregate expressions, you can use
conditional clauses to filter rows, providing more flexibility than SQL language.
The PowerCenter Server performs aggregate calculations as it reads, and stores necessary data
group and row data in an aggregate cache.
After you create a session that includes an Aggregator transformation, you can enable the
session option, Incremental Aggregation. When the PowerCenter Server performs incremental
aggregation, it passes new source data through the mapping and uses historical cache data to
perform new aggregation calculations incrementally. For details on incremental aggregation,
see “Using Incremental Aggregation” in the Workflow Administration Guide.
Ports in the Aggregator Transformation
To configure ports in the Aggregator transformation, complete the following tasks:
♦ Enter an expression in any output port, using conditional clauses or non-aggregate
functions in the port.
♦ Create multiple aggregate output ports.
♦ Configure any input, input/output, output, or variable port as a group by port.
♦ Improve performance by connecting only the necessary input/output ports to subsequent
transformations, reducing the size of the data cache.
♦ Use variable ports for local variables.
♦ Create connections to other transformations as you enter an expression.
Components of the Aggregator Transformation
The Aggregator is an active transformation, changing the number of rows in the pipeline. The
Aggregator transformation has the following components and options:
♦ Aggregate expression. Entered in an output port. Can include non-aggregate expressions
and conditional clauses.
2 Chapter 1: Aggregator Transformation
♦ Group by port. Indicates how to create groups. The port can be any input, input/output,
output, or variable port. When grouping data, the Aggregator transformation outputs the
last row of each group unless otherwise specified.
♦ Sorted input. Use to improve session performance. To use sorted input, you must pass
data to the Aggregator transformation sorted by group by port, in ascending or descending
order.
♦ Aggregate cache. The PowerCenter Server stores data in the aggregate cache until it
completes aggregate calculations. It stores group values in an index cache and row data in
the data cache.
Aggregate Caches
When you run a session that uses an Aggregator transformation, the PowerCenter Server
creates index and data caches in memory to process the transformation. If the PowerCenter
Server requires more space, it stores overflow values in cache files.
You can configure the index and data caches in the Aggregator transformation or in the
session properties. For more information, see “Creating an Aggregator Transformation” on
page 11.
Note: The PowerCenter Server uses memory to process an Aggregator transformation with
sorted ports. It does not use cache memory. You do not need to configure cache memory for
Aggregator transformations that use sorted ports.
Overview 3
Aggregate Expressions
The Designer allows aggregate expressions only in the Aggregator transformation. An
aggregate expression can include conditional clauses and non-aggregate functions. It can also
include one aggregate function nested within another aggregate function, such as:
MAX( COUNT( ITEM ))
The result of an aggregate expression varies depending on the group by ports used in the
transformation. For example, when the PowerCenter Server calculates the following aggregate
expression with no group by ports defined, it finds the total quantity of items sold:
SUM( QUANTITY )
However, if you use the same expression, and you group by the ITEM port, the PowerCenter
Server returns the total quantity of items sold, by item.
You can create an aggregate expression in any output port and use multiple aggregate ports in
a transformation.
Aggregate Functions
You can use the following aggregate functions within an Aggregator transformation. You can
nest one aggregate function within another aggregate function.
The transformation language includes the following aggregate functions:
♦ AVG
♦ COUNT
♦ FIRST
♦ LAST
♦ MAX
♦ MEDIAN
♦ MIN
♦ PERCENTILE
♦ STDDEV
♦ SUM
♦ VARIANCE
When you use any of these functions, you must use them in an expression within an
Aggregator transformation. For a description of these functions, see “Functions” in the
Transformation Language Reference.
4 Chapter 1: Aggregator Transformation
Nested Aggregate Functions
You can include multiple single-level or multiple nested functions in different output ports in
an Aggregator transformation. However, you cannot include both single-level and nested
functions in an Aggregator transformation. Therefore, if an Aggregator transformation
contains a single-level function in any output port, you cannot use a nested function in any
other port in that transformation. When you include single-level and nested functions in the
same Aggregator transformation, the Designer marks the mapping or mapplet invalid. If you
need to create both single-level and nested functions, create separate Aggregator
transformations.
Conditional Clauses
You can use conditional clauses in the aggregate expression to reduce the number of rows used
in the aggregation. The conditional clause can be any clause that evaluates to TRUE or
FALSE.
For example, you can use the following expression to calculate the total commissions of
employees who exceeded their quarterly quota:
SUM( COMMISSION, COMMISSION > QUOTA )
Non-Aggregate Functions
You can also use non-aggregate functions in the aggregate expression.
The following expression returns the highest number of items sold for each item (grouped by
item). If no items were sold, the expression returns 0.
IIF( MAX( QUANTITY ) > 0, MAX( QUANTITY ), 0))
Null Values in Aggregate Functions
When you configure the PowerCenter Server, you can choose how you want the PowerCenter
Server to handle null values in aggregate functions. You can choose to treat null values in
aggregate functions as NULL or zero. By default, the PowerCenter Server treats null values as
NULL in aggregate functions.
For details on changing this default behavior, see “Installing and Configuring the
PowerCenter Server on Windows” and “Installing and Configuring the PowerCenter Server
on UNIX” chapters in the Installation and Configuration Guide.
Aggregate Expressions 5
Group By Ports
The Aggregator transformation allows you to define groups for aggregations, rather than
performing the aggregation across all input data. For example, rather than finding the total
company sales, you can find the total sales grouped by region.
To define a group for the aggregate expression, select the appropriate input, input/output,
output, and variable ports in the Aggregator transformation. You can select multiple group by
ports, creating a new group for each unique combination of groups. The PowerCenter Server
then performs the defined aggregation for each group.
When you group values, the PowerCenter Server produces one row for each group. If you do
not group values, the PowerCenter Server returns one row for all input rows. The
PowerCenter Server typically returns the last row of each group (or the last row received) with
the result of the aggregation. However, if you specify a particular row to be returned (for
example, by using the FIRST function), the PowerCenter Server then returns the specified
row.
When selecting multiple group by ports in the Aggregator transformation, the PowerCenter
Server uses port order to determine the order by which it groups. Since group order can affect
your results, order group by ports to ensure the appropriate grouping. For example, the results
of grouping by ITEM_ID then QUANTITY can vary from grouping by QUANTITY then
ITEM_ID, because the numeric values for quantity are not necessarily unique.
The following Aggregator transformation groups first by STORE_ID and then by ITEM:
If you send the following data through this Aggregator transformation:
STORE_ID ITEM QTY PRICE
101 ‘battery’ 3 2.99
101 ‘battery’ 1 3.19
101 ‘battery’ 2 2.59
101 ‘AAA’ 2 2.45
201 ‘battery’ 1 1.99
201 ‘battery’ 4 1.59
301 ‘battery’ 1 2.45
6 Chapter 1: Aggregator Transformation
The PowerCenter Server performs the aggregate calculation on the following unique groups:
STORE_ID ITEM
101 ‘battery’
101 ‘AAA’
201 ‘battery’
301 ‘battery’
The PowerCenter Server then passes the last row received, along with the results of the
aggregation, as follows:
STORE_ID ITEM QTY PRICE SALES_PER_STORE
101 ‘battery’ 2 2.59 17.34
101 ‘AAA’ 2 2.45 4.90
201 ‘battery’ 4 1.59 8.35
301 ‘battery’ 1 2.45 2.45
Non-Aggregate Expressions
You can use non-aggregate expressions in group by ports to modify or replace groups. For
example, if you want to replace ‘AAA battery’ before grouping, you can create a new group by
output port, named CORRECTED_ITEM, using the following expression:
IIF( ITEM = ‘AAA battery’, battery, ITEM )
Default Values
You can use default values in the group by port to replace null input values. For example, if
you define a default value of ‘Misc’ in the ITEM column below, the PowerCenter Server
replaces null groups with ‘Misc’. This allows the PowerCenter Server to include null item
Group By Ports 7
groups in the aggregation. For more information about default values, see “Transformations”
in the Designer Guide.
8 Chapter 1: Aggregator Transformation
Using Sorted Input
You can improve Aggregator transformation performance by using the sorted input option.
When you use sorted input, the PowerCenter Server assumes all data is sorted by group. As
the PowerCenter Server reads rows for a group, it performs aggregate calculations. When
necessary, it stores group information in memory. To use the Sorted Input option, you must
pass sorted data to the Aggregator transformation. You can gain performance with sorted
ports when you configure the session with multiple partitions.
When you do not use sorted input, the PowerCenter Server performs aggregate calculations as
it reads. However, since data is not sorted, the PowerCenter Server stores data for each group
until it reads the entire source to ensure all aggregate calculations are accurate.
For example, one Aggregator transformation has the STORE_ID and ITEM group by ports,
with the sorted input option selected. When you pass the following data through the
Aggregator, the PowerCenter Server performs an aggregation for the three rows in the
101/battery group as soon as it finds the new group, 201/battery:
STORE_ID ITEM QTY PRICE
101 ‘battery’ 3 2.99
101 ‘battery’ 1 3.19
101 ‘battery’ 2 2.59
201 ‘battery’ 4 1.59
201 ‘battery’ 1 1.99
If you use sorted input and do not presort data correctly, you receive unexpected results.
Sorted Input Conditions
Do not use sorted input if either of the following conditions are true:
♦ The aggregate expression uses nested aggregate functions.
♦ The session uses incremental aggregation.
If you use sorted input and do not sort data correctly, the session fails.
Pre-Sorting Data
To use sorted input, you pass sorted data through the Aggregator.
Data must be sorted as follows:
♦ By the Aggregator group by ports, in the order they appear in the Aggregator
transformation.
♦ Using the same sort order configured for the session. If data is not in strict ascending or
descending order based on the session sort order, the PowerCenter Server fails the session.
Using Sorted Input 9
For example, if you configure a session to use a French sort order, data passing into the
Aggregator transformation must be sorted using the French sort order.
For relational and file sources, you can use the Sorter transformation to sort data in the
mapping before passing it to the Aggregator transformation. You can place the Sorter
transformation anywhere in the mapping prior to the Aggregator if no transformation changes
the order of the sorted data. Group by columns in the Aggregator transformation must be in
the same order as they appear in the Sorter transformation. For details on sorting data using
the Sorter transformation, see “Sorter Transformation” on page 283.
If the session uses relational sources, you can also use the Number of Sorted Ports option in
the Source Qualifier transformation to sort group by columns in the source database. Group
by columns must be in the same order in both the Aggregator and Source Qualifier
transformations. For details on sorting data in the Source Qualifier, see “Using Sorted Ports”
on page 317.
Figure 1-1 illustrates the mapping with a Sorter transformation configured to sort the source
data in descending order by ITEM_NAME:
Figure 1-1. Sample Mapping with Aggregator and Sorter Transformations
The Sorter transformation sorts the data as follows:
ITEM_NAME QTY PRICE
Soup 4 2.95
Soup 1 2.95
Soup 2 3.25
Cereal 1 4.49
Cereal 2 5.25
With sorted input, the Aggregator transformation returns the following results:
ITEM_NAME QTY PRICE INCOME_PER_ITEM
Cereal 2 5.25 14.99
Soup 2 3.25 21.25
10 Chapter 1: Aggregator Transformation
Creating an Aggregator Transformation
To use an Aggregator transformation in a mapping, you add the Aggregator transformation to
the mapping, then configure the transformation with an aggregate expression and group by
ports, if desired.
To create an Aggregator transformation:
1. In the Mapping Designer, choose Transformation-Create. Select the Aggregator
transformation.
2. Enter a name for the Aggregator, click Create. Then click Done.
The Designer creates the Aggregator transformation.
3. Drag the desired ports to the Aggregator transformation.
The Designer creates input/output ports for each port you include.
4. Double-click the title bar of the transformation to open the Edit Transformations dialog
box.
5. Select the Ports tab.
6. Click the group by option for each column you want the Aggregator to use in creating
groups.
You can optionally enter a default value to replace null groups.
If you want to use a non-aggregate expression to modify groups, click the Add button and
enter a name and data type for the port. Make the port an output port by clearing Input
(I). Click in the right corner of the Expression field, enter the non-aggregate expression
using one of the input ports, then click OK. Select Group By.
7. Click Add and enter a name and data type for the aggregate expression port. Make the
port an output port by clearing Input (I). Click in the right corner of the Expression field
to open the Expression Editor. Enter the aggregate expression, click Validate, then click
OK.
Make sure the expression validates before closing the Expression Editor.
8. Add default values for specific ports as necessary.
If certain ports are likely to contain null values, you might specify a default value if the
target database does not handle null values.
Creating an Aggregator Transformation 11
9. Select the Properties tab.
Select and modify these options as needed:
Aggregator Setting Description
Cache Directory Local directory where the PowerCenter Server creates the index and data cache files.
By default, the PowerCenter Server uses the directory entered in the Workflow Manager
for the server variable $PMCacheDir. If you enter a new directory, make sure the
directory exists and contains enough disk space for the aggregate caches.
Tracing Level Amount of detail displayed in the session log for this transformation.
Sorted Input Indicates input data is presorted by groups. Select this option only if the mapping
passes sorted data to the Aggregator transformation.
Aggregator Data Data cache size for the transformation. Default cache size is 2,000,000 bytes. If the
Cache Size total configured session cache size is 2 GB (2,147,483,648 bytes) or greater, you must
run the session on a 64-bit PowerCenter Server.
Aggregator Index Index cache size for the transformation. Default cache size is 1,000,000 bytes. If the
Cache Size total configured session cache size is 2 GB (2,147,483,648 bytes) or greater, you must
run the session on a 64-bit PowerCenter Server.
Transformation Scope Specifies how the PowerCenter Server applies the transformation logic to incoming
data:
- Transaction. Applies the transformation logic to all rows in a transaction. Choose
Transaction when a row of data depends on all rows in the same transaction, but does
not depend on rows in other transactions.
- All Input. Applies the transformation logic on all incoming data. When you choose All
Input, the PowerCenter drops incoming transaction boundaries. Choose All Input
when a row of data depends on all rows in the source.
For more information about transformation scope, see “Understanding Commit Points”
in the Workflow Administration Guide.
12 Chapter 1: Aggregator Transformation
10. Click OK.
11. Choose Repository-Save to save changes to the mapping.
Creating an Aggregator Transformation 13
Tips
You can use the following guidelines to optimize the performance of an Aggregator
transformation.
Use sorted input to decrease the use of aggregate caches.
Sorted input reduces the amount of data cached during the session and improves session
performance. Use this option with the Sorter transformation to pass sorted data to the
Aggregator transformation.
Limit connected input/output or output ports.
Limit the number of connected input/output or output ports to reduce the amount of data
the Aggregator transformation stores in the data cache.
Filter before aggregating.
If you use a Filter transformation in the mapping, place the transformation before the
Aggregator transformation to reduce unnecessary aggregation.
14 Chapter 1: Aggregator Transformation
Troubleshooting
I selected sorted input but the workflow takes the same amount of time as before.
You cannot use sorted input if any of the following conditions are true:
♦ The aggregate expression contains nested aggregate functions.
♦ The session uses incremental aggregation.
♦ Source data is data driven.
When any of these conditions are true, the PowerCenter Server processes the transformation
as if you do not use sorted input.
A session using an Aggregator transformation causes slow performance.
The PowerCenter Server may be paging to disk during the workflow. You can increase session
performance by increasing the index and data cache sizes in the transformation properties. For
more information about caching, see “Session Caches” in the Workflow Administration Guide.
I entered an override cache directory in the Aggregator transformation, but the
PowerCenter Server saves the session incremental aggregation files somewhere else.
You can override the transformation cache directory on a session level. The PowerCenter
Server notes the cache directory in the session log. You can also check the session properties
for an override cache directory.
Troubleshooting 15
16 Chapter 1: Aggregator Transformation
Chapter 2
Custom Transformation
This chapter includes the following topics:
♦ Overview, 18
♦ Creating Custom Transformations, 20
♦ Working with Groups and Ports, 22
♦ Working with Port Attributes, 25
♦ Custom Transformation Properties, 27
♦ Working with Transaction Control, 30
♦ Blocking Input Data, 32
♦ Working with Procedure Properties, 35
♦ Creating Custom Transformation Procedures, 36
17
Overview
Transformation type:
Active/Passive
Connected
Custom transformations operate in conjunction with procedures you create outside of the
Designer interface to extend PowerCenter functionality. You can create a Custom
transformation and bind it to a procedure that you develop using the functions described in
“Custom Transformation Functions” on page 51.
You can use the Custom transformation to create transformation applications, such as sorting
and aggregation, which require all input rows to be processed before outputting any output
rows. To support this process, the input and output functions occur separately in Custom
transformations compared to External Procedure transformations.
The PowerCenter Server passes the input data to the procedure using an input function. The
output function is a separate function that you must enter in the procedure code to pass
output data to the PowerCenter Server. In contrast, in the External Procedure transformation,
an external procedure function does both input and output, and its parameters consist of all
the ports of the transformation.
You can also use the Custom transformation to create a transformation that requires multiple
input groups, multiple output groups, or both. A group is the representation of a row of data
entering or leaving a transformation. For example, you might create a Custom transformation
with one input group and multiple output groups that parses XML data. Or, you can create a
Custom transformation with two input groups and one output group that merges two streams
of input data into one stream of output data.
Code Page Compatibility
The Custom transformation procedure code page is the code page of the data the Custom
transformation procedure processes. The following factors determine the Custom
transformation procedure code page:
♦ PowerCenter Server data movement mode
♦ The INFA_CTChangeStringMode() function
♦ The INFA_CTSetDataCodePageID() function
The Custom transformation procedure code page must be two-way compatible with the
PowerCenter Server code page. The PowerCenter Server passes data to the procedure in the
Custom transformation procedure code page. Also, the data the procedure passes to the
PowerCenter Server must be valid characters in the Custom transformation procedure code
page.
By default, when the PowerCenter Server runs in ASCII mode, the Custom transformation
procedure code page is ASCII. Also, when the PowerCenter Server runs in Unicode mode, the
18 Chapter 2: Custom Transformation
Custom transformation procedure code page is UCS-2, but the PowerCenter Server only
passes characters that are valid in the PowerCenter Server code page.
However, you can use the INFA_CTChangeStringMode() functions in the procedure code to
request the data in a different format. In addition, when the PowerCenter Server runs in
Unicode mode, you can request the data in a different code page using the
INFA_CTSetDataCodePageID() function.
Changing the format or requesting the data in a different code page changes the Custom
transformation procedure code page to the code page the procedure requests:
♦ ASCII mode. You can write the external procedure code to request the data in UCS-2
format using the INFA_CTChangeStringMode() function. When you use this function,
the procedure must pass only ASCII characters in UCS-2 format to the PowerCenter
Server. Do not use the INFA_CTSetDataCodePageID() function when the PowerCenter
Server runs in ASCII mode.
♦ Unicode mode. You can write the external procedure code to request the data in MBCS
using the INFA_CTChangeStringMode() function. When the external procedure requests
the data in MBCS, the PowerCenter Server passes the data in the PowerCenter Server code
page. When you use the INFA_CTChangeStringMode() function, you can write the
external procedure code to request the data in a different code page from the PowerCenter
Server code page using the INFA_CTSetDataCodePageID() function. The code page you
specify in the INFA_CTSetDataCodePageID() function must be two-way compatible with
the PowerCenter Server code page.
Note: You can also use the INFA_CTRebindInputDataType() function to change the format
for a specific port in the Custom transformation.
Distributing Custom Transformation Procedures
You can copy a Custom transformation from one repository to another. When you copy a
Custom transformation between repositories, you must verify that the PowerCenter Server
machine the target repository uses contains the Custom transformation procedure.
Overview 19
Creating Custom Transformations
You can create reusable Custom transformations in the Transformation Developer, and add
instances of the transformation to mappings. You can create non-reusable Custom
transformations in the Mapping Designer or Mapplet Designer.
Each Custom transformation specifies a module and a procedure name. You can create a
Custom transformation based on an existing shared library or DLL containing the procedure,
or you can create a Custom transformation as the basis for creating the procedure. When you
create a Custom transformation to use with an existing shared library or DLL, make sure you
define the correct module and procedure name.
When you create a Custom transformation as the basis for creating the procedure, select the
transformation and generate the code. The Designer uses the transformation properties when
it generates the procedure code. It generates code in a single directory for all transformations
sharing a common module name.
The Designer generates the following files:
♦ m_<module_name>.c. Defines the module. This file includes an initialization function,
m_<module_name>_moduleInit() that allows you to write code you want the
PowerCenter Server to run when it loads the module. Similarly, this file includes a
deinitialization function, m_<module_name>_moduleDeinit(), that allows you to write
code you want the PowerCenter Server to run before it unloads the module.
♦ p_<procedure_name>.c. Defines the procedure in the module. This file contains the code
that implements the procedure logic, such as data cleansing or merging data.
♦ makefile.aix, makefile.aix64,makefile.hp, makefile.hp64, makefile.linux, makefile.sol.
Make files for the UNIX platforms. Use makefile.aix64 for 64-bit AIX platforms and
makefile.hp64 for 64-bit HP-UX (Itanium) platforms.
Rules and Guidelines
Use the following rules and guidelines when you create a Custom transformation:
♦ Custom transformations are connected transformations. You cannot reference a Custom
transformation in an expression.
♦ You can include multiple procedures in one module. For example, you can include an
XML writer procedure and an XML parser procedure in the same module.
♦ You can bind one shared library or DLL to multiple Custom transformation instances if
you write the procedure code to handle multiple Custom transformation instances.
♦ When you write the procedure code, you must make sure it does not violate basic mapping
rules. For more information about mappings and mapping validation, see “Mappings” in
the Transformation Guide.
♦ The Custom transformation sends and receives high precision decimals as high precision
decimals.
♦ You can use multi-threaded code in Custom transformation procedures.
20 Chapter 2: Custom Transformation
Custom Transformation Components
When you configure a Custom transformation, you define the following components:
♦ Transformation tab. You can rename the transformation and add a description on the
Transformation tab.
♦ Ports tab. You can add and edit ports and groups to a Custom transformation. For more
information about creating ports and groups, see “Working with Groups and Ports” on
page 22. You can also define the input ports an output port depends on. For more
information about defining port dependencies, see “Defining Port Relationships” on
page 23.
♦ Port Attribute Definitions tab. You can create user-defined port attributes for Custom
transformation ports. For more information about creating and editing port attributes, see
“Working with Port Attributes” on page 25.
♦ Properties tab. You can define transformation properties such as module and function
identifiers, transaction properties, and the runtime location. For more information about
defining transformation properties, see “Custom Transformation Properties” on page 27.
♦ Initialization Properties tab. You can define properties that the external procedure uses at
runtime, such as during initialization. For more information about creating initialization
properties, see “Working with Procedure Properties” on page 35.
♦ Metadata Extensions tab. You can create metadata extensions to define properties that the
procedure uses at runtime, such as during initialization. For more information about using
metadata extensions for procedure properties, see “Working with Procedure Properties” on
page 35.
Creating Custom Transformations 21
Working with Groups and Ports
A Custom transformation has both input and output groups. It also can have input ports,
output ports, and input/output ports. You create and edit groups and ports on the Ports tab of
the Custom transformation. You can also define the relationship between input and output
ports on the Ports tab.
Figure 2-1 shows the Custom transformation Ports tab:
Figure 2-1. Custom Transformation Ports Tab
Add and delete groups,
and edit port attributes.
First Input Group Header
Output Group Header
Second Input Group Header
Coupled Group Headers
Creating Groups and Ports
You can create multiple input groups and multiple output groups in a Custom
transformation. You must create at least one input group and one output group. To create an
input group, click the Create Input Group icon. To create an output group, click the Create
Output Group icon. When you create a group, the Designer adds it as the last group. When
you create a passive Custom transformation, you can only create one input group and one
output group.
To create a port, click the Add button. When you create a port, the Designer adds it below the
currently selected row or group. Each port contains attributes defined on the Port Attribute
Definitions tab. You can edit the attributes for each port. For more information about
creating and editing user-defined port attributes, see “Working with Port Attributes” on
page 25.
22 Chapter 2: Custom Transformation
Editing Groups and Ports
Use the following rules and guidelines when you edit ports and groups in a Custom
transformation:
♦ You can change group names by typing in the group header.
♦ You can only enter ASCII characters for port and group names.
♦ Once you create a group, you cannot change the group type. If you need to change the
group type, delete the group and add a new group.
♦ When you delete a group, the Designer deletes all ports of the same type in that group.
However, all input/output ports remain in the transformation, belong to the group above
them, and change to input ports or output ports, depending on the type of group you
delete. For example, an output group contains output ports and input/output ports. You
delete the output group. The Designer deletes the output ports. It changes the input/
output ports to input ports. Those input ports belong to the input group with the header
directly above them.
♦ To move a group up or down, select the group header and click the Move Port Up or Move
Port Down button. The ports above and below the group header remain the same, but the
groups to which they belong might change.
Defining Port Relationships
By default, an output port in a Custom transformation depends on all input ports. However,
you can define the relationship between input and output ports in a Custom transformation.
When you do this, you can view link paths in a mapping containing a Custom transformation
and you can see which input ports an output port depends on. You can also view source
column dependencies for target ports in a mapping containing a Custom transformation.
To define the relationship between ports in a Custom transformation, create a port
dependency. A port dependency is the relationship between an output or input/output port
and one or more input or input/output ports. When you create a port dependency, base it on
the procedure logic in the code.
To create a port dependency, click Custom Transformation on the Ports tab and choose Port
Dependencies.
Working with Groups and Ports 23
Figure 2-2 illustrates where you create and edit port dependencies:
Figure 2-2. Editing Port Dependencies
Choose an output or input/output port.
Add a port dependency.
Remove a port dependency.
Choose an input or input/output port on
which the output or input/output port
depends.
Suppose you create a external procedure that parses XML data. You create a Custom
transformation with one input group containing one input port and multiple output groups
containing multiple output ports. According to the external procedure logic, all output ports
depend on the input port. You can define this relationship in the Custom transformation by
creating a port dependency for each output port. Define each port dependency so that the
output port depends on the one input port.
To create a port dependency:
1. On the Ports tab, click Custom Transformation and choose Port Dependencies.
2. In the Output Port Dependencies dialog box, select an output or input/output port in
the Output Port field.
3. In the Input Ports pane, select an input or input/output port on which the output port or
input/output port depends.
4. Click Add.
5. Repeat steps 3 through 4 to include more input or input/output ports in the port
dependency.
6. To create another port dependency, repeat steps 2 through 5.
7. Click OK.
24 Chapter 2: Custom Transformation
Working with Port Attributes
Ports have certain attributes, such as datatype and precision. When you create a Custom
transformation, you can create user-defined port attributes. User-defined port attributes apply
to all ports in a Custom transformation.
Suppose you create a external procedure to parse XML data. You can create a port attribute
called “XML path” where you can define the position of an element in the XML hierarchy.
Create port attributes and assign default values on the Port Attribute Definitions tab of the
Custom transformation. You can define a specific port attribute value for each port on the
Ports tab.
Figure 2-3 shows the Port Attribute Definitions tab where you create port attributes:
Figure 2-3. Port Attribute Definitions Tab
Port Attribute
Default Value
When you create a port attribute, define the following properties:
♦ Name. The name of the port attribute.
♦ Datatype. The datatype of the port attribute value. You can choose Boolean, Numeric, or
String.
♦ Value. The default value of the port attribute. This property is optional. When you enter a
value here, the value applies to all ports in the Custom transformation. You can override
the port attribute value for each port on the Ports tab.
You define port attributes for each Custom transformation. You cannot copy a port attribute
from one Custom transformation to another.
Working with Port Attributes 25
Editing Port Attribute Values
After you create port attributes, you can edit the port attribute values for each port in the
transformation. To edit the port attribute values, click Custom Transformation on the Ports
tab and choose Edit Port Attribute.
Figure 2-4 shows where you edit port attribute values:
Figure 2-4. Edit Port Attribute Values
Filter ports by group.
Edit port attribute value.
Revert to default port attribute
value.
You can change the port attribute value for a particular port by clicking the Open button.
This opens the Edit Port Attribute Default Value dialog box. Or, you can enter a new value by
typing directly in the Value column.
You can filter the ports listed in the Edit Port Level Attributes dialog box by choosing a group
from the Select Group field.
26 Chapter 2: Custom Transformation
Custom Transformation Properties
Properties for the Custom transformation identify specifications for both the procedure and
the transformation. Configure the Custom transformation properties on the Properties tab of
the Edit Transformations dialog box.
Figure 2-5 illustrates the Custom transformation Properties tab:
Figure 2-5. Custom Transformation Properties
Table 2-1 describes the Custom transformation properties:
Table 2-1. Custom Transformation Properties
Option Description
Module Identifier The module name. Enter only ASCII characters in this field. You cannot enter multibyte
characters.
This property is the base name of the DLL or the shared library that contains the procedure.
The Designer uses this name to create the C file when you generate the external procedure
code.
Function Identifier The name of the procedure in the module. Enter only ASCII characters in this field. You
cannot enter multibyte characters.
The Designer uses this name to create the C file where you enter the procedure code.
Custom Transformation Properties 27
Table 2-1. Custom Transformation Properties
Option Description
Runtime Location The location that contains the DLL or shared library. The default is $PMExtProcDir. Enter a
path relative to the PowerCenter Server machine that runs the session using the Custom
transformation.
If you make this property blank, the PowerCenter Server uses the environment variable
defined on the PowerCenter Server machine to locate the DLL or shared library.
You must copy all DLLs or shared libraries to the runtime location or to the environment
variable defined on the PowerCenter Server machine. The PowerCenter Server fails to load
the procedure when it cannot locate the DLL, shared library, or a referenced file.
Tracing Level Amount of detail displayed in the session log for this transformation. The default is Normal.
Is Partitionable Specifies whether or not you can create multiple partitions in a pipeline that uses this
transformation. This property is disabled by default.
Inputs Must Block Specifies whether or not the procedure associated with the transformation must be able to
block incoming data. This property is enabled by default.
For more information about blocking data, see “Blocking Input Data” on page 32.
Is Active Specifies whether this transformation is an active or passive transformation.
You cannot change this property after you create the Custom transformation. If you need to
change this property, create a new Custom transformation and select the correct property
value.
Update Strategy Specifies whether or not this transformation defines the update strategy for output rows. This
Transformation property is disabled by default. You can enable this for active Custom transformations.
For more information about this property, see “Setting the Update Strategy” on page 29.
Transformation Scope Specifies how the PowerCenter Server applies the transformation logic to incoming data:
- Row
- Transaction
- All Input
When the transformation is passive, this property is always Row. When the transformation is
active, this property is All Input by default.
For more information about working with transaction control, see “Working with Transaction
Control” on page 30.
Generate Transaction Specifies whether or not this transformation can generate transactions. When a Custom
transformation generates transactions, it does so for all output groups.
This property is disabled by default. You can only enable this for active Custom
transformations.
For more information about working with transaction control, see “Working with Transaction
Control” on page 30.
Output is Repeatable Specifies whether the order of the output data is consistent between session runs.
- Never. The order of the output data is inconsistent between session runs. This is the default
for active transformations.
- Based On Input Order. The output order is consistent between session runs when the input
data order is consistent between session runs. This is the default for passive
transformations.
- Always. The order of the output data is consistent between session runs even if the order of
the input data is inconsistent between session runs.
28 Chapter 2: Custom Transformation
Pipeline Partitioning
When you include a Custom transformation in a mapping, you can specify whether or not
you can configure multiple partitions in the pipeline. Select Is Partitionable to allow multiple
partitions. If the procedure code is not thread-safe, do not select this property.
The Workflow Manager allows you to add partitions to the pipeline when the Custom
transformation allows multiple partitions.
You can create a partition point at a Custom transformation even when the Custom
transformation does not allow multiple partitions. Consider the following rules and
guidelines when you add a partition point at a Custom transformation:
♦ You can define the partition type for each input group in the transformation. You do not
define partition information for output groups.
♦ Valid partition types are pass-through, round-robin, key range and hash user keys.
♦ You define the same number of partitions for all groups.
For more information about pipeline partitioning, see “Pipeline Partitioning” in the Workflow
Administration Guide.
Setting the Update Strategy
You can use an active Custom transformation to set the update strategy for a mapping. To do
so, you must set the update strategy at the following levels:
♦ Within the procedure. You can write the external procedure code to set the update strategy
for output rows. The external procedure can flag rows for insert, update, delete, or reject.
For more information about the functions you can use to set the update strategy, see “Row
Strategy Functions (Row-Based Mode)” on page 89.
♦ Within the mapping. Use the Custom transformation in a mapping to flag rows for insert,
update, delete, or reject. Select the Update Strategy Transformation property for the
Custom transformation.
♦ Within the session. Configure the session to treat the source rows as data driven.
If you do not configure the Custom transformation to define the update strategy, or you do
not configure the session as data driven, the PowerCenter Server does not use the external
procedure code to flag the output rows. Instead, when the Custom transformation is active,
the PowerCenter Server flags the output rows as insert. When the Custom transformation is
passive, the PowerCenter Server retains the row type. For example, when a row flagged for
update enters a passive Custom transformation, the PowerCenter Server maintains the row
type and outputs the row as update.
Custom Transformation Properties 29
Working with Transaction Control
You can define transaction control for Custom transformations using the following
transformation properties:
♦ Transformation Scope. Determines how the PowerCenter Server applies the
transformation logic to incoming data.
♦ Generate Transaction. Specifies that the procedure generates transaction rows and outputs
them to the output groups.
Transformation Scope
You can configure how the PowerCenter Server applies the transformation logic to incoming
data. You can choose one of the following values:
♦ Row. Applies the transformation logic to one row of data at a time. Choose Row when the
results of the procedure depend on a single row of data. For example, you might choose
Row when a procedure parses a row containing an XML file.
♦ Transaction. Applies the transformation logic to all rows in a transaction. Choose
Transaction when the results of the procedure depend on all rows in the same transaction,
but not on rows in other transactions. When you choose Transaction, you must connect all
input groups to the same transaction control point. For example, you might choose
Transaction when the external procedure performs aggregate calculations on the data in a
single transaction.
♦ All Input. Applies the transformation logic to all incoming data. When you choose All
Input, the PowerCenter Server drops transaction boundaries. Choose All Input when the
results of the procedure depend on all rows of data in the source. For example, you might
choose All Input when the external procedure performs aggregate calculations on all
incoming data, or when it sorts all incoming data.
For more information about transformation scope, see “Understanding Commit Points” in
the Workflow Administration Guide.
Generate Transaction
You can write the external procedure code to output transactions, such as commit and
rollback rows. When the external procedure outputs commit and rollback rows, configure the
Custom transformation to generate transactions. Select the Generate Transaction
transformation property. You can enable this property for active Custom transformations. For
information on the functions you use to generate transactions, see “Data Boundary Output
Notification Function” on page 82.
When the external procedure outputs a commit or rollback row, it does so for all output
groups.
When you configure the transformation to generate transactions, the PowerCenter Server
treats the Custom transformation like a Transaction Control transformation. Most rules that
30 Chapter 2: Custom Transformation
apply to a Transaction Control transformation in a mapping also apply to the Custom
transformation. For example, when you configure a Custom transformation to generate
transactions, you cannot concatenate pipelines or pipeline branches containing the
transformation. For more information about working with Transaction Control
transformations, see “Transaction Control Transformation” on page 357.
When you edit or create a session using a Custom transformation configured to generate
transactions, configure it for user-defined commit.
Working with Transaction Boundaries
The PowerCenter Server handles transaction boundaries entering and leaving Custom
transformations based on the mapping configuration and the Custom transformation
properties.
Table 2-2 describes how the PowerCenter Server handles transaction boundaries at Custom
transformations:
Table 2-2. Transaction Boundary Handling with Custom Transformations
Transformation
Generate Transactions Enabled Generate Transactions Disabled
Scope
Row The PowerCenter Server drops incoming When the incoming data for all input groups
transaction boundaries and does not call the comes from the same transaction control point,
data boundary notification function. the PowerCenter Server preserves incoming
It outputs transaction rows according to the transaction boundaries and outputs them
procedure logic across all output groups. across all output groups. However, it does not
call the data boundary notification function.
When the incoming data for the input groups
comes from different transaction control points,
the PowerCenter Server drops incoming
transaction boundaries. It does not call the
data boundary notification function. The
PowerCenter Server outputs all rows in one
open transaction.
Transaction The PowerCenter Server preserves incoming The PowerCenter Server preserves incoming
transaction boundaries and calls the data transaction boundaries and calls the data
boundary notification function. boundary notification function.
However, it outputs transaction rows according It outputs the transaction rows across all output
to the procedure logic across all output groups. groups.
All Input The PowerCenter Server drops incoming The PowerCenter Server drops incoming
transaction boundaries and does not call the transaction boundaries and does not call the
data boundary notification function. The data boundary notification function. It outputs
PowerCenter Server outputs transaction rows all rows in one open transaction.
according to the procedure logic across all
output groups.
Working with Transaction Control 31
Blocking Input Data
By default, the PowerCenter Server concurrently reads sources in a target load order group.
However, you can write the external procedure code to block input data on some input
groups. Blocking is the suspension of the data flow into an input group of a multiple input
group transformation. For more information about blocking source data, see “Understanding
the Server Architecture” in the Workflow Administration Guide.
To use a Custom transformation to block input data, you must write the procedure code to
block and unblock data. You must also enable blocking on the Properties tab for the Custom
transformation.
Writing the Procedure Code to Block Data
You can write the procedure to block and unblock incoming data. To block incoming data,
use the INFA_CTBlockInputFlow() function. To unblock incoming data, use the
INFA_CTUnblockInputFlow() function. For more information about the blocking
functions, see “Blocking Logic Functions” on page 86.
You might want to block input data if the external procedure needs to alternate reading from
input groups. Without the blocking functionality, you would need to write the procedure
code to buffer incoming data. You can block input data instead of buffering it which usually
increases session performance.
For example, you need to create a external procedure with two input groups. The external
procedure reads a row from the first input group and then reads a row from the second input
group. If you use blocking, you can write the external procedure code to block the flow of
data from one input group while it processes the data from the other input group. When you
write the external procedure code to block data, you increase performance because the
procedure does not need to copy the source data to a buffer. However, you could write the
external procedure to allocate a buffer and copy the data from one input group to the buffer
until it is ready to process the data. Copying source data to a buffer decreases performance.
Configuring Custom Transformations as Blocking Transformations
When you create a Custom transformation, the Designer enables the Inputs Must Block
transformation property by default. This property affects data flow validation when you save
or validate a mapping. When you enable this property, the Custom transformation is a
blocking transformation. When you clear this property, the Custom transformation is not a
blocking transformation. For more information about blocking transformations, see
“Transformations” in the Designer Guide.
Configure the Custom transformation as a blocking transformation when the external
procedure code must be able to block input data.
32 Chapter 2: Custom Transformation
You can configure the Custom transformation as a non-blocking transformation when one of
the following conditions is true:
♦ The procedure code does not include the blocking functions.
♦ The procedure code includes two algorithms, one that uses blocking logic and the other
that copies the source data to a buffer allocated by the procedure instead of blocking data.
The code checks whether or not the PowerCenter Server allows the Custom
transformation to block data. The procedure uses the algorithm with the blocking
functions when it can block, and uses the other algorithm when it cannot block. You
might want to do this to create a Custom transformation that you can use in multiple
mapping configurations.
For more information about verifying whether the PowerCenter Server allows a Custom
transformation to block data, see “Validating Mappings with Custom Transformations” on
page 33.
Note: When the procedure blocks data and you configure the Custom transformation as a
non-blocking transformation, the PowerCenter Server fails the session.
Validating Mappings with Custom Transformations
When you include a Custom transformation in a mapping, both the Designer and
PowerCenter Server validate the mapping. The Designer validates the mapping you save or
validate and the PowerCenter Server validates the mapping when you run the session.
Validating at Design Time
When you save or validate a mapping, the Designer performs data flow validation. When the
Designer does this, it verifies that the data can flow from all sources in a target load order
group to the targets without blocking transformations blocking all sources. Some mappings
with blocking transformations are invalid. For more information about data flow validation,
see “Mappings” in the Designer Guide.
Validating at Runtime
When you run a session, the PowerCenter Server validates the mapping against the procedure
code at runtime. When the PowerCenter Server does this, it tracks whether or not it allows
the Custom transformations in the mapping to block data:
♦ Configure the Custom transformation as a blocking transformation. The PowerCenter
Server always allows the Custom transformation to block data.
♦ Configure the Custom transformation as a non-blocking transformation. The
PowerCenter Server allows the Custom transformation to block data depending on the
mapping configuration. If the PowerCenter Server can block data at the Custom
transformation without blocking all sources in the target load order group simultaneously,
it allows the Custom transformation to block data.
You can write the procedure code to check whether or not the PowerCenter Server allows a
Custom transformation in the mapping to block data. Use the
Blocking Input Data 33
INFA_CT_getInternalProperty() function to access the
INFA_CT_TRANS_MAY_BLOCK_DATA property ID. The PowerCenter Server returns
TRUE when the Custom transformation can block data, and it returns FALSE when the
Custom transformation cannot block data. For more information about the
INFA_CT_getInternalProperty() function, see “Property Functions” on page 70.
34 Chapter 2: Custom Transformation
Working with Procedure Properties
You can define property name and value pairs in the Custom transformation that the
procedure can use when the PowerCenter Server runs the procedure, such as during
initialization time. You can create user-defined properties on the following tabs of the Custom
transformation:
♦ Metadata Extensions. You can specify the property name, datatype, precision, and value.
Informatica recommends using metadata extensions for passing information to the
procedure. For more information about creating metadata extensions, see “Metadata
Extensions” in the Repository Guide.
♦ Initialization Properties. You can specify the property name and value.
While you can define properties on both tabs in the Custom transformation, the Metadata
Extensions tab allows you to provide more detail for the property. Informatica recommends
you use metadata extensions to pass properties to the procedure.
Suppose you create a Custom transformation external procedure that sorts data after
transforming it. You could create a boolean metadata extension named Sort_Ascending.
When you use the Custom transformation in a mapping, you can choose True or False for the
metadata extension, depending on how you want the procedure to sort the data.
When you define a property in the Custom transformation, you can use the get all property
names functions, such as INFA_CTGetAllPropertyNamesM(), to access the names of all
properties defined on the Initialization Properties and Metadata Extensions tab. You can use
the get external property functions, such as INFA_CT_getExternalPropertyM(), to access the
property name and value of a property ID you specify.
Note: When you define a metadata extension and an initialization property with the same
name, the property functions only return information for the metadata extension.
Working with Procedure Properties 35
Creating Custom Transformation Procedures
You can create Custom transformation procedures that run on 32-bit or 64-bit PowerCenter
Server machines. Use the following steps as a guideline when you create a Custom
transformation procedure:
1. In the Transformation Developer, create a reusable Custom transformation. Or, in the
Mapplet Designer or Mapping Designer, create a non-reusable Custom transformation.
2. Generate the template code for the procedure.
When you generate the procedure code, the Designer uses the information from the
Custom transformation to create C source code files and makefiles.
3. Modify the C files to add the procedure logic.
4. Use your C/C++ compiler to compile and link the source code files into a DLL or shared
library and copy it to the PowerCenter Server machine.
5. Create a mapping with the Custom transformation.
6. Run the session in a workflow.
In this section, we use an example, the “Union example,” to demonstrate this process. The
steps in this section create a Custom transformation that contains two input groups and one
output group. The Custom transformation procedure verifies that the Custom transformation
uses two input groups and one output group. It also verifies that the number of ports in all
groups are equal and that the port datatypes are the same for all groups. The procedure takes
rows of data from each input group and outputs all rows to the output group.
Step 1. Create the Custom Transformation
The first step is to create a Custom transformation.
To create a Custom transformation:
1. In the Transformation Developer, choose Transformation-Create.
2. In the Create Transformation dialog box, choose Custom transformation, enter a
transformation name, and click Create.
In the Union example, enter CT_Inf_Union as the transformation name.
3. In the Active or Passive dialog box, create the transformation as a passive or active
transformation, and click OK.
In the Union example, choose Active.
4. Click Done to close the Create Transformation dialog box.
5. Open the transformation and click the Ports tab. Create groups and ports.
You can edit the groups and ports later, if necessary. For more information about creating
groups and ports, see “Working with Groups and Ports” on page 22.
36 Chapter 2: Custom Transformation
In the Union example, create the groups and ports shown in Figure 2-6:
Figure 2-6. Custom Transformation Ports Tab - Union Example
First Input Group
Second Input Group
Output Group
6. Select the Properties tab and enter a module and function identifier and the runtime
location. Edit other transformation properties as necessary.
For more information about Custom transformation properties, see “Custom
Transformation Properties” on page 27.
Creating Custom Transformation Procedures 37
In the Union example, enter the properties shown in Figure 2-7:
Figure 2-7. Custom Transformation Properties Tab - Union Example
7. Click the Metadata Extensions tab to enter metadata extensions, such as properties the
external procedure might need for initialization. For more information about using
metadata extensions for procedure properties, see “Working with Procedure Properties”
on page 35.
In the Union example, do not create metadata extensions.
8. Click the Port Attribute Definitions tab to create port attributes, if necessary. For more
information about creating port attributes, see “Working with Port Attributes” on
page 25.
In the Union example, do not create port attributes.
9. Click OK.
10. Choose Repository-Save.
After you create the Custom transformation that calls the procedure, the next step is to
generate the C files.
Step 2. Generate the C Files
After you create a Custom transformation, you generate the source code files. The Designer
generates file names in lower case.
To generate the code for a Custom transformation procedure:
1. In the Transformation Developer, select the transformation and choose Transformation-
Generate Code.
38 Chapter 2: Custom Transformation
2. Select the procedure you just created. The Designer lists the procedures as
<module_name>.<procedure_name>.
In the Union example, select UnionDemo.Union.
3. Specify the directory where you want to generate the files, and click Generate.
In the Union example, select <client_installation_directory>/TX.
The Designer creates a subdirectory, <module_name>, in the directory you specified. In
the Union example, the Designer creates <client_installation_directory>/TX/
UnionDemo. It also creates the following files:
♦ m_UnionDemo.c
♦ m_UnionDemo.h
♦ p_Union.c
♦ p_Union.h
♦ makefile.aix (32-bit), makefile.aix64 (64-bit), makefile.hp (32-bit), makefile.hp64
(64-bit), makefile.linux (32-bit), and makefile.sol (32-bit).
Step 3. Fill Out the Code with the Transformation Logic
You must code the procedure C file. Optionally, you can also code the module C file. In the
Union example, you fill out the procedure C file only. You do not need to fill out the module
C file.
To code the procedure C file:
1. Open p_<procedure_name>.c for the procedure.
In the Union example, open p_Union.c.
2. Enter the C code for the procedure.
3. Save the modified file.
In the Union example, use the following code:
/**************************************************************************
*
* Copyright (c) 2003 Informatica Corporation. This file contains
* material proprietary to Informatica Corporation and may not be copied
* or distributed in any form without the written permission of Informatica
* Corporation
*
**************************************************************************/
/**************************************************************************
* Custom Transformation p_union Procedure File
*
* This file contains code that functions that will be called by the main
Creating Custom Transformation Procedures 39
* server executable.
*
* for more information on these files,
* see $(PM_HOME)/ExtProc/include/Readme.txt
**************************************************************************/
/*
* INFORMATICA 'UNION DEMO' developed using the API for custom
* transformations.
* File Name: p_Union.c
*
* An example of a custom transformation ('Union') using PowerCenter7.0
*
* The purpose of the 'Union' transformation is to combine pipelines with the
* same row definition into one pipeline (i.e. union of multiple pipelines).
* [ Note that it does not correspond to the mathematical definition of union
* since it does not eliminate duplicate rows.]
*
* This example union transformation allows N input pipelines ( each
* corresponding to an input group) to be combined into one pipeline.
*
* To use this transformation in a mapping, the following attributes must be
* true:
* a. The transformation must have >= 2 input groups and only one output group.
* b. In the Properties tab set the following properties:
* i. Module Identifier: UnionDemo
* ii. Function Identifier: Union
* iii. Inputs May Block: Unchecked
* iv. Is Active: Checked
* v. Update Strategy Transformation: Unchecked *
* vi. Transformation Scope: All
* vii. Generate Transaction: Unchecked *
*
* * This version of the union transformation does not provide code for
* changing the update strategy or for generating transactions.
* c. The input groups and the output group must have the same number of ports
* and the same datatypes. This is verified in the initialization of the
* module and the session is failed if this is not true.
* d. The transformation can be used in multiple number of times in a Target
* Load Order Group and can also be contained within multiple partitions.
*
*/
40 Chapter 2: Custom Transformation
/**************************************************************************
Includes
**************************************************************************/
include <stdlib.h>
#include "p_union.h"
/**************************************************************************
Forward Declarations
**************************************************************************/
INFA_STATUS validateProperties(const INFA_CT_PARTITION_HANDLE* partition);
/**************************************************************************
Functions
**************************************************************************/
/**************************************************************************
Function: p_union_procInit
Description: Initialization for the procedure. Returns INFA_SUCCESS if
procedure initialization succeeds, else return INFA_FAILURE.
Input: procedure - the handle for the procedure
Output: None
Remarks: This function will get called once for the session at
initialization time. It will be called after the moduleInit function.
**************************************************************************/
INFA_STATUS p_union_procInit( INFA_CT_PROCEDURE_HANDLE procedure)
{
const INFA_CT_TRANSFORMATION_HANDLE* transformation = NULL;
const INFA_CT_PARTITION_HANDLE* partition = NULL;
size_t nTransformations = 0, nPartitions = 0, i = 0;
/* Log a message indicating beginning of the procedure initialization */
INFA_CTLogMessageM( eESL_LOG,
"union_demo: Procedure initialization started ..." );
INFA_CTChangeStringMode( procedure, eASM_MBCS );
/* Get the transformation handles */
transformation = INFA_CTGetChildrenHandles( procedure,
&nTransformations,
TRANSFORMATIONTYPE);
Creating Custom Transformation Procedures 41
/* For each transformation verify that the 0th partition has the correct
* properties. This does not need to be done for all partitions since rest
* of the partitions have the same information */
for (i = 0; i < nTransformations; i++)
{
/* Get the partition handle */
partition = INFA_CTGetChildrenHandles(transformation[i],
&nPartitions, PARTITIONTYPE );
if (validateProperties(partition) != INFA_SUCCESS)
{
INFA_CTLogMessageM( eESL_ERROR,
"union_demo: Failed to validate attributes of "
"the transformation");
return INFA_FAILURE;
}
}
INFA_CTLogMessageM( eESL_LOG,
"union_demo: Procedure initialization completed." );
return INFA_SUCCESS;
}
/**************************************************************************
Function: p_union_procDeinit
Description: Deinitialization for the procedure. Returns INFA_SUCCESS if
procedure deinitialization succeeds, else return INFA_FAILURE.
Input: procedure - the handle for the procedure
Output: None
Remarks: This function will get called once for the session at
deinitialization time. It will be called before the moduleDeinit
function.
**************************************************************************/
INFA_STATUS p_union_procDeinit( INFA_CT_PROCEDURE_HANDLE procedure,
INFA_STATUS sessionStatus )
{
/* Do nothing ... */
return INFA_SUCCESS;
}
42 Chapter 2: Custom Transformation
/**************************************************************************
Function: p_union_partitionInit
Description: Initialization for the partition. Returns INFA_SUCCESS if
partition deinitialization succeeds, else return INFA_FAILURE.
Input: partition - the handle for the partition
Output: None
Remarks: This function will get called once for each partition for each
transformation in the session.
**************************************************************************/
INFA_STATUS p_union_partitionInit( INFA_CT_PARTITION_HANDLE partition )
{
/* Do nothing ... */
return INFA_SUCCESS;
}
/**************************************************************************
Function: p_union_partitionDeinit
Description: Deinitialization for the partition. Returns INFA_SUCCESS if
partition deinitialization succeeds, else return INFA_FAILURE.
Input: partition - the handle for the partition
Output: None
Remarks: This function will get called once for each partition for each
transformation in the session.
**************************************************************************/
INFA_STATUS p_union_partitionDeinit( INFA_CT_PARTITION_HANDLE partition )
{
/* Do nothing ... */
return INFA_SUCCESS;
}
/**************************************************************************
Function: p_union_inputRowNotification
Description: Notification that a row needs to be processed for an input
group in a transformation for the given partition. Returns INFA_ROWSUCCESS
if the input row was processed successfully, INFA_ROWFAILURE if the input
row was not processed successfully and INFA_FATALERROR if the input row
Creating Custom Transformation Procedures 43
causes the session to fail.
Input: partition - the handle for the partition for the given row
group - the handle for the input group for the given row
Output: None
Remarks: This function is probably where the meat of your code will go,
as it is called for every row that gets sent into your transformation.
**************************************************************************/
INFA_ROWSTATUS p_union_inputRowNotification( INFA_CT_PARTITION_HANDLE partition,
INFA_CT_INPUTGROUP_HANDLE inputGroup )
{
const INFA_CT_OUTPUTGROUP_HANDLE* outputGroups = NULL;
const INFA_CT_INPUTPORT_HANDLE* inputGroupPorts = NULL;
const INFA_CT_OUTPUTPORT_HANDLE* outputGroupPorts = NULL;
size_t nNumInputPorts = 0, nNumOutputGroups = 0,
nNumPortsInOutputGroup = 0, i = 0;
/* Get the output group port handles */
outputGroups = INFA_CTGetChildrenHandles(partition,
&nNumOutputGroups,
OUTPUTGROUPTYPE);
outputGroupPorts = INFA_CTGetChildrenHandles(outputGroups[0],
&nNumPortsInOutputGroup,
OUTPUTPORTTYPE);
/* Get the input groups port handles */
inputGroupPorts = INFA_CTGetChildrenHandles(inputGroup,
&nNumInputPorts,
INPUTPORTTYPE);
/* For the union transformation, on receiving a row of input, we need to
* output that row on the output group. */
for (i = 0; i < nNumInputPorts; i++)
{
INFA_CTSetData(outputGroupPorts[i],
INFA_CTGetDataVoid(inputGroupPorts[i]));
INFA_CTSetIndicator(outputGroupPorts[i],
INFA_CTGetIndicator(inputGroupPorts[i]) );
INFA_CTSetLength(outputGroupPorts[i],
44 Chapter 2: Custom Transformation
INFA_CTGetLength(inputGroupPorts[i]) );
}
/* We know there is only one output group for each partition */
return INFA_CTOutputNotification(outputGroups[0]);
}
/**************************************************************************
Function: p_union_eofNotification
Description: Notification that the last row for an input group has already
been seen. Return INFA_FAILURE if the session should fail as a result of
seeing this notification, INFA_SUCCESS otherwise.
Input: partition - the handle for the partition for the notification
group - the handle for the input group for the notification
Output: None
**************************************************************************/
INFA_STATUS p_union_eofNotification( INFA_CT_PARTITION_HANDLE partition,
INFA_CT_INPUTGROUP_HANDLE group)
{
INFA_CTLogMessageM( eESL_LOG,
"union_demo: An input group received an EOF notification");
return INFA_SUCCESS;
}
/**************************************************************************
Function: p_union_dataBdryNotification
Description: Notification that a transaction has ended. The data
boundary type can either be commit or rollback.
Return INFA_FAILURE if the session should fail as a result of
seeing this notification, INFA_SUCCESS otherwise.
Input: partition - the handle for the partition for the notification
transactionType - commit or rollback
Output: None
**************************************************************************/
INFA_STATUS p_union_dataBdryNotification ( INFA_CT_PARTITION_HANDLE partition,
INFA_CT_DATABDRY_TYPE transactionType)
{
Creating Custom Transformation Procedures 45
/* Do nothing */
return INFA_SUCCESS;
}
/* Helper functions */
/**************************************************************************
Function: validateProperties
Description: Validate that the transformation has all properties expected
by a union transformation, such as at least one input group, and only
one output group. Return INFA_FAILURE if the session should fail since the
transformation was invalid, INFA_SUCCESS otherwise.
Input: partition - the handle for the partition
Output: None
**************************************************************************/
INFA_STATUS validateProperties(const INFA_CT_PARTITION_HANDLE* partition)
{
const INFA_CT_INPUTGROUP_HANDLE* inputGroups = NULL;
const INFA_CT_OUTPUTGROUP_HANDLE* outputGroups = NULL;
size_t nNumInputGroups = 0, nNumOutputGroups = 0;
const INFA_CT_INPUTPORT_HANDLE** allInputGroupsPorts = NULL;
const INFA_CT_OUTPUTPORT_HANDLE* outputGroupPorts = NULL;
size_t nNumPortsInOutputGroup = 0;
size_t i = 0, nTempNumInputPorts = 0;
/* Get the input and output group handles */
inputGroups = INFA_CTGetChildrenHandles(partition[0],
&nNumInputGroups,
INPUTGROUPTYPE);
outputGroups = INFA_CTGetChildrenHandles(partition[0],
&nNumOutputGroups,
OUTPUTGROUPTYPE);
/* 1. Number of input groups must be >= 2 and number of output groups must
* be equal to one. */
if (nNumInputGroups < 1 || nNumOutputGroups != 1)
{
INFA_CTLogMessageM( eESL_ERROR,
"UnionDemo: There must be at least two input groups "
"and only one output group");
46 Chapter 2: Custom Transformation
return INFA_FAILURE;
}
/* 2. Verify that the same number of ports are in each group (including
* output group). */
outputGroupPorts = INFA_CTGetChildrenHandles(outputGroups[0],
&nNumPortsInOutputGroup,
OUTPUTPORTTYPE);
/* Allocate an array for all input groups ports */
allInputGroupsPorts = malloc(sizeof(INFA_CT_INPUTPORT_HANDLE*) *
nNumInputGroups);
for (i = 0; i < nNumInputGroups; i++)
{
allInputGroupsPorts[i] = INFA_CTGetChildrenHandles(inputGroups[i],
&nTempNumInputPorts,
INPUTPORTTYPE);
if ( nNumPortsInOutputGroup != nTempNumInputPorts)
{
INFA_CTLogMessageM( eESL_ERROR,
"UnionDemo: The number of ports in all input and "
"the output group must be the same.");
return INFA_FAILURE;
}
}
free(allInputGroupsPorts);
/* 3. Datatypes of ports in input group 1 must match data types of all other
* groups.
TODO:*/
return INFA_SUCCESS;
}
Creating Custom Transformation Procedures 47
Step 4. Build the Module
You can build the module on a Windows or UNIX platform.
Table 2-3 lists the library file names for each platform when you build the module:
Table 2-3. Module File Names
Platform Module File Name
Windows <module_identifier>.dll
AIX lib<module_identifier>.a
HP-UX lib<module_identifier>.sl
Linux lib<module_identifier>.so
Solaris lib<module_identifier>.so
Building the Module on a Windows Platform
On Windows, you can use Microsoft Visual C++ to compile the DLL.
To build a DLL on Windows:
1. Start Visual C++.
2. Choose File-New.
3. In the New dialog box, click the Projects tab and select the Win32 Dynamic-Link Library
option.
4. Enter its location.
In the Union example, enter <client_installation_directory>/TX/UnionDemo.
5. Enter the name of the project.
You must use the module name specified for the Custom transformation as the project
name. In the Union example, enter UnionDemo.
6. Click OK.
Visual C++ creates a wizard to help you define the project components.
7. In the wizard, select An empty DLL project and click Finish. Click OK in the New
Project Information dialog box.
Visual C++ creates the project files in the directory you specified.
8. Choose Project-Add To Project-Files.
48 Chapter 2: Custom Transformation
9. Navigate up a directory level. This directory contains the procedure files you created.
Select all .c files and click OK.
In the Union example, add the following files:
♦ m_UnionDemo.c
♦ p_Union.c
10. Choose Project-Settings.
11. Click the C/C++ tab, and select Preprocessor from the Category field.
12. In the Additional Include Directories field, enter the following path and click OK:
..; <PowerCenter_Server_install_dir>\extproc\include\ct
13. Choose Build-Build <module_name>.dll or press F7 to build the project.
Visual C++ creates the DLL and places it in the debug or release directory under the
project directory.
Building the Module on a UNIX Platform
On UNIX, you can use any C compiler to build the module.
To build shared libraries on UNIX:
1. Copy all C files and makefiles generated by the Designer to the UNIX machine.
Note: If you build the shared library on a machine other than the PowerCenter Server
machine, you must also copy the files in the following directory to the build machine:
<PowerCenter_Server_install_dir>\ExtProc\include\ct
In the Union example, copy all files in <client_installation_directory>/TX/UnionDemo.
2. Set the environment variable PM_HOME to the PowerCenter Server installation
directory.
Note: If you specify an incorrect directory path for the PM_HOME environment variable,
the PowerCenter Server cannot start.
3. Enter a command from Table 2-4 to make the project.
Table 2-4. UNIX Commands for Building the Shared Library
UNIX Version Command
AIX (32-bit) make -f makefile.aix
AIX (64-bit) make -f makefile.aix64
HP-UX (32-bit) make -f makefile.hp
HP-UX (64-bit) make -f makefile.hp64
Linux make -f makefile.linux
Solaris make -f makefile.sol
Creating Custom Transformation Procedures 49
Step 5. Create a Mapping
In the Mapping Designer, create a mapping that uses the Custom transformation.
In the Union example, create a mapping similar to the one in Figure 2-8:
Figure 2-8. Mapping with a Custom Transformation - Union Example
In this mapping, two sources with the same ports and datatypes connect to the two input
groups in the Custom transformation. The Custom transformation takes the rows from both
sources and outputs them all through its one output group. The output group has the same
ports and datatypes as the input groups.
Step 6. Run the Session in a Workflow
When you run the session, the PowerCenter Server looks for the shared library or DLL in the
runtime location you specify in the Custom transformation.
To run a session in a workflow:
1. In the Workflow Manager, create a workflow.
2. Create a session for this mapping in the workflow.
3. Copy the shared library or DLL to the runtime location directory.
4. Run the workflow containing the session.
When the PowerCenter Server loads a Custom transformation bound to a procedure, it
loads the DLL or shared library and calls the procedure you define.
50 Chapter 2: Custom Transformation
Chapter 3
Custom Transformation
Functions
This chapter includes the following topic:
♦ Overview, 52
♦ Function Reference, 54
♦ Working with Rows, 58
♦ Generated Functions, 60
♦ API Functions, 66
♦ Array-Based API Functions, 91
51
Overview
Custom transformations operate in conjunction with procedures you create outside of the
Designer to extend PowerCenter functionality. The Custom transformation functions allow
you to develop the transformation logic in a procedure you associate with a Custom
transformation. PowerCenter provides two sets of functions called generated and API
functions. The PowerCenter Server uses generated functions to interface with the procedure.
When you create a Custom transformation and generate the source code files, the Designer
includes the generated functions in the files. Use the API functions in the procedure code to
develop the transformation logic.
When you write the procedure code, you can configure it to receive a block of rows from the
PowerCenter Server or a single row at a time. You can increase the procedure performance
when it receives and processes a block of rows. For more information about receiving rows
from the PowerCenter Server, see “Working with Rows” on page 58.
Working with Handles
Most functions are associated with a handle, such as INFA_CT_PARTITION_HANDLE.
The first parameter for these functions is the handle the function affects. Custom
transformation handles have a hierarchical relationship to each other. A parent handle has a
1:n relationship to its child handle.
52 Chapter 3: Custom Transformation Functions
Figure 3-1 illustrates the Custom transformation handles:
Figure 3-1. Custom Transformation Handles
INFA_CT_MODULE_HANDLE Parent handle to INFA_CT_PROC_HANDLE
contains n contains 1
INFA_CT_PROC_HANDLE Child handle to INFA_CT_MODULE_HANDLE
contains n contains 1
INFA_CT_TRANS_HANDLE
contains n contains 1
INFA_CT_PARTITION_HANDLE
contains n contains 1 contains n contains 1
INFA_CT_INPUTGROUP_HANDLE INFA_CT_OUTPUTGROUP_HANDLE
contains n contains 1 contains n contains 1
INFA_CT_INPUTPORT_HANDLE INFA_CT_OUTPUTPORT_HANDLE
Table 3-1 describes the Custom transformation handles:
Table 3-1. Custom Transformation Handles
Handle Name Description
INFA_CT_MODULE_HANDLE Represents the shared library or DLL. The external procedure can only access
the module handle in its own shared library or DLL. It cannot access the
module handle in any other shared library or DLL.
INFA_CT_PROC_HANDLE Represents a specific procedure within the shared library or DLL.
You might use this handle when you need to write a function to affect a
procedure referenced by multiple Custom transformations.
INFA_CT_TRANS_HANDLE Represents a specific Custom transformation instance in the session.
INFA_CT_PARTITION_HANDLE Represents a specific partition in a specific Custom transformation instance.
INFA_CT_INPUTGROUP_HANDLE Represents an input group in a partition.
INFA_CT_INPUTPORT_HANDLE Represents an input port in an input group in a partition.
INFA_CT_OUTPUTGROUP_HANDLE Represents an output group in a partition.
INFA_CT_OUTPUTPORT_HANDLE Represents an output port in an output group in a partition.
Overview 53
Function Reference
The Custom transformation functions include generated and API functions.
Table 3-2 lists the Custom transformation generated functions:
Table 3-2. Custom Transformation Generated Functions
Function Description
m_<module_name>_moduleInit() Module initialization function. For more information, see “Module
Initialization Function” on page 60.
p_<proc_name>_procInit() Procedure initialization function. For more information, see “Procedure
Initialization Function” on page 61.
p_<proc_name>_partitionInit() Partition initialization function. For more information, see “Partition
Initialization Function” on page 61.
p_<proc_name>_inputRowNotification() Input row notification function. For more information, see “Input Row
Notification Function” on page 62.
p_<proc_name>_dataBdryNotification() Data boundary notification function. For more information, see “Data
Boundary Notification Function” on page 63.
p_<proc_name>_eofNotification() End of file notification function. For more information, see “End Of File
Notification Function” on page 63.
p_<proc_name>_partitionDeinit() Partition deinitialization function. For more information, see “Partition
Deinitialization Function” on page 64.
p_<proc_name>_procedureDeinit() Procedure deinitialization function. For more information, see “Procedure
Deinitialization Function” on page 64.
m_<module_name>_moduleDeinit() Module deinitialization function. For more information, see “Module
Deinitialization Function” on page 65.
Table 3-3 lists the Custom transformation API functions:
Table 3-3. Custom Transformation API Functions
Function Description
INFA_CTSetDataAccessMode() Set data access mode function. For more information, see “Set Data
Access Mode Function” on page 66.
INFA_CTGetAncestorHandle() Get ancestor handle function. For more information, see “Get Ancestor
Handle Function” on page 67.
INFA_CTGetChildrenHandles() Get children handles function. For more information, see “Get Children
Handles Function” on page 68.
INFA_CTGetInputPortHandle() Get input port handle function. For more information, see “Get Port
Handle Functions” on page 69.
INFA_CTGetOutputPortHandle() Get output port handle function. For more information, see “Get Port
Handle Functions” on page 69.
54 Chapter 3: Custom Transformation Functions
Table 3-3. Custom Transformation API Functions
Function Description
INFA_CTGetInternalProperty<datatype>() Get internal property function. For more information, see “Get Internal
Property Function” on page 70.
INFA_CTGetAllPropertyNamesM() Get all property names in MBCS mode function. For more information,
see “Get All External Property Names (MBCS or Unicode)” on page 74.
INFA_CTGetAllPropertyNamesU() Get all property names in Unicode mode function. For more
information, see “Get All External Property Names (MBCS or Unicode)”
on page 74.
INFA_CTGetExternalProperty<datatype>M() Get external property in MBCS function. For more information, see “Get
External Properties (MBCS or Unicode)” on page 75.
INFA_CTGetExternalProperty<datatype>U() Get external property in Unicode function. For more information, see
“Get External Properties (MBCS or Unicode)” on page 75.
INFA_CTRebindInputDataType() Rebind input port datatype function. For more information, see “Rebind
Datatype Functions” on page 76.
INFA_CTRebindOutputDataType() Rebind output port datatype function. For more information, see
“Rebind Datatype Functions” on page 76.
INFA_CTGetData<datatype>() Get data functions. For more information, see “Get Data Functions
(Row-Based Mode)” on page 79.
INFA_CTSetData() Set data functions. For more information, see “Set Data Function (Row-
Based Mode)” on page 79.
INFA_CTGetIndicator() Get indicator function. For more information, see “Indicator Functions
(Row-Based Mode)” on page 80.
INFA_CTSetIndicator() Set indicator function. For more information, see “Indicator Functions
(Row-Based Mode)” on page 80.
INFA_CTGetLength() Get length function. For more information, see “Length Functions” on
page 81.
INFA_CTSetLength() Set length function. For more information, see “Length Functions” on
page 81.
INFA_CTSetPassThruPort() Set pass through port function. For more information, see “Set Pass
Through Port Function” on page 81.
INFA_CTOutputNotification() Output notification function. For more information, see “Output
Notification Function” on page 82.
INFA_CTDataBdryOutputNotification() Data boundary output notification function. For more information, see
“Data Boundary Output Notification Function” on page 82.
INFA_CTGetErrorMsgU() Get error message in Unicode function. For more information, see
“Error Functions” on page 83.
INFA_CTGetErrorMsgM() Get error message in MBCS function. For more information, see “Error
Functions” on page 83.
INFA_CTLogMessageU() Log message in the session log in Unicode function. For more
information, see “Session Log Message Functions” on page 84.
Function Reference 55
Table 3-3. Custom Transformation API Functions
Function Description
INFA_CTLogMessageM() Log message in the session log in MBCS function. For more
information, see “Session Log Message Functions” on page 84.
INFA_CTIncrementErrorCount() Increment error count function. For more information, see “Increment
Error Count Function” on page 85.
INFA_CTIsTerminateRequested() Is terminate requested function. For more information, see “Is
Terminated Function” on page 85.
INFA_CTBlockInputFlow() Block input groups function. For more information, see “Blocking Logic
Functions” on page 86.
INFA_CTUnblockInputFlow() Unblock input groups function. For more information, see “Blocking
Logic Functions” on page 86.
INFA_CTSetUserDefinedPointer() Set user-defined pointer function. For more information, see “Pointer
Functions” on page 87.
INFA_CTGetUserDefinedPointer() Get user-defined pointer function. For more information, see “Pointer
Functions” on page 87.
INFA_CTChangeStringMode() Change the string mode function. For more information, see “Change
String Mode Function” on page 87.
INFA_CTSetDataCodePageID() Set the data code page ID function. For more information, see “Set
Data Code Page Function” on page 88.
INFA_CTGetRowStrategy() Get row strategy function. For more information, see “Row Strategy
Functions (Row-Based Mode)” on page 89.
INFA_CTSetRowStrategy() Set the row strategy function. For more information, see “Row Strategy
Functions (Row-Based Mode)” on page 89.
INFA_CTChangeDefaultRowStrategy() Changes the default row strategy of a transformation. For more
information, see “Change Default Row Strategy Function” on page 90.
Table 3-4 lists the Custom transformation array-based functions:
Table 3-4. Custom Transformation Array-Based API Functions
Function Description
INFA_CTAGetInputRowMax() Get maximum number of input rows function. For more information, see
“Maximum Number of Rows Functions” on page 91.
INFA_CTAGetOutputRowMax() Get maximum number of output rows function. For more information,
see “Maximum Number of Rows Functions” on page 91.
INFA_CTASetOutputRowMax() Set maximum number of output rows function. For more information,
see “Maximum Number of Rows Functions” on page 91.
INFA_CTAGetNumRows() Get number of rows function. For more information, see “Number of
Rows Functions” on page 92.
INFA_CTASetNumRows() Set number of rows function. For more information, see “Number of
Rows Functions” on page 92.
56 Chapter 3: Custom Transformation Functions
Table 3-4. Custom Transformation Array-Based API Functions
Function Description
INFA_CTAIsRowValid() Is row valid function. For more information, see “Is Row Valid Function”
on page 93.
INFA_CTAGetData<datatype>() Get data functions. For more information, see “Get Data Functions
(Array-Based Mode)” on page 94.
INFA_CTAGetIndicator() Get indicator function. For more information, see “Get Indicator
Function (Array-Based Mode)” on page 95.
INFA_CTASetData() Set data function. For more information, see “Set Data Function (Array-
Based Mode)” on page 95.
INFA_CTAGetRowStrategy() Get row strategy function. For more information, see “Row Strategy
Functions (Array-Based Mode)” on page 96.
INFA_CTASetRowStrategy() Set row strategy function. For more information, see “Row Strategy
Functions (Array-Based Mode)” on page 96.
INFA_CTASetInputErrorRowM() Set input error row function for MBCS. For more information, see “Set
Input Error Row Functions” on page 97.
INFA_CTASetInputErrorRowU() Set input error row function for Unicode. For more information, see “Set
Input Error Row Functions” on page 97.
Function Reference 57
Working with Rows
The PowerCenter Server can pass a single row to a Custom transformation procedure or a
block of rows in an array. You can write the procedure code to specify whether the procedure
receives one row or a block of rows. You can increase performance when the procedure
receives a block of rows:
♦ You can decrease the number of function calls the PowerCenter Server and procedure
make. The PowerCenter Server calls the input row notification function fewer times, and
the procedure calls the output notification function fewer times.
♦ You can increase the locality of memory access space for the data.
♦ You can write the procedure code to perform an algorithm on a block of data instead of
each row of data.
By default, the procedure receives a row of data at a time. To receive a block of rows, you must
include the INFA_CTSetDataAccessMode() function to change the data access mode to
array-based. When the data access mode is array-based, you must use the array-based data
handling and row strategy functions to access and output the data. When the data access
mode is row-based, you must use the row-based data handling and row strategy functions to
access and output the data.
All array-based functions use the prefix INFA_CTA. All other functions use the prefix
INFA_CT. For more information about the array-based functions, see “Array-Based API
Functions” on page 91.
Use the following steps to write the procedure code to access a block of rows:
1. Call INFA_CTSetDataAccessMode() during the procedure initialization, to change the
data access mode to array-based.
2. When you create a passive Custom transformation, you can also call
INFA_CTSetPassThruPort() during procedure initialization to pass through the data for
input/output ports.
When a block of data reaches the Custom transformation procedure, the PowerCenter
Server calls p_<proc_name>_inputRowNotification() for each block of data. Perform the
rest of the steps inside this function.
3. Call INFA_CTAGetNumRows() using the input group handle in the input row
notification function to find the number of rows in the current block.
4. Call one of the INFA_CTAGetData<datatype>() functions using the input port handle
to get the data for a particular row in the block.
5. Call INFA_CTASetData to output rows in a block.
6. Before calling INFA_CTOutputNotification(), call INFA_CTASetNumRows() to notify
the PowerCenter Server of the number of rows the procedure is outputting in the block.
7. Call INFA_CTOutputNotification().
58 Chapter 3: Custom Transformation Functions
Rules and Guidelines
Use the following rules and guidelines when you write the procedure code to use either row-
based or array-based data access mode:
♦ In row-based mode, you can return INFA_ROWERROR in the input row notification
function to indicate the function encountered an error for the row of data on input. The
PowerCenter Server increments the internal error count.
♦ In array-based mode, do not return INFA_ROWERROR in the input row notification
function. The PowerCenter Server treats that as a fatal error. If you need to indicate a row
in a block has an error, call the INFA_CTASetInputErrorRowM() or
INFA_CTASetInputErrorRowU() function.
♦ In row-based mode, the PowerCenter Server only passes valid rows to the procedure.
♦ In array-based mode, an input block may contain invalid rows, such as dropped, filtered,
or error rows. Call INFA_CTAIsRowValid() to determine if a row in a block is valid.
♦ In array-based mode, do not call INFA_CTASetNumRows() for a passive Custom
transformation. You can only call this function for active Custom transformations.
♦ In array-based mode, only call INFA_CTOutputNotification() once.
♦ In array-based mode, you can only call INFA_CTSetPassThruPort() for passive Custom
transformations.
♦ In array-based mode for passive Custom transformations, you must output all rows in an
output block, including any error row.
Working with Rows 59
Generated Functions
When you use the Designer to generate the procedure code, the Designer includes a set of
functions called generated functions in the m_<module_name>.c and p_<procedure_name>.c
files. The PowerCenter Server uses the generated functions to interface with the procedure.
When you run a session, the PowerCenter Server calls these generated functions in the
following order for each target load order group in the mapping:
1. Initialization functions
2. Notification functions
3. Deinitialization functions
Initialization Functions
The PowerCenter Server first calls the initialization functions. Use the initialization functions
to write processes you want the PowerCenter Server to run before it passes data to the Custom
transformation. Writing code in the initialization functions reduces processing overhead
because the PowerCenter Server runs these processes only once for a module, procedure, or
partition.
The Designer generates the following initialization functions:
♦ m_<module_name>_moduleInit(). For more information, see “Module Initialization
Function” on page 60.
♦ p_<proc_name>_procInit(). For more information, see “Procedure Initialization
Function” on page 61.
♦ p_<proc_name>_partitionInit(). For more information, see “Partition Initialization
Function” on page 61.
Module Initialization Function
The PowerCenter Server calls the m_<module_name>_moduleInit() function during session
initialization, before it runs the pre-session tasks. It calls this function, once for a module,
before all other functions.
If you want the PowerCenter Server to run a specific process when it loads the module, you
must include it in this function. For example, you might write code to create global structures
that procedures within this module access.
Use the following syntax:
INFA_STATUS m_<module_name>_moduleInit(INFA_CT_MODULE_HANDLE module);
Input/
Argument Datatype Description
Output
module INFA_CT_MODULE_HANDLE Input Module handle.
60 Chapter 3: Custom Transformation Functions
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value. When the function returns INFA_FAILURE, the PowerCenter Server fails
the session.
Procedure Initialization Function
The PowerCenter Server calls p_<proc_name>_procInit() function during session
initialization, before it runs the pre-session tasks and after it runs the module initialization
function. The PowerCenter Server calls this function once for each procedure in the module.
Write code in this function when you want the PowerCenter Server to run a process for a
particular procedure. You can also enter some API functions in the procedure initialization
function, such as navigation and property functions.
Use the following syntax:
INFA_STATUS p_<proc_name>_procInit(INFA_CT_PROCEDURE_HANDLE procedure);
Input/
Argument Datatype Description
Output
procedure INFA_CT_PROCEDURE_HANDLE Input Procedure handle.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value. When the function returns INFA_FAILURE, the PowerCenter Server fails
the session.
Partition Initialization Function
The PowerCenter Server calls p_<proc_name>_partitionInit() function before it passes data
to the Custom transformation. The PowerCenter Server calls this function once for each
partition at a Custom transformation instance.
If you want the PowerCenter Server to run a specific process before it passes data through a
partition of the Custom transformation, you must include it in this function.
Use the following syntax:
INFA_STATUS p_<proc_name>_partitionInit(INFA_CT_PARTITION_HANDLE
transformation);
Input/
Argument Datatype Description
Output
transformation INFA_CT_PARTITION_HANDLE Input Partition handle.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value. When the function returns INFA_FAILURE, the PowerCenter Server fails
the session.
Generated Functions 61
Notification Functions
The PowerCenter Server calls the notification functions when it passes a row of data to the
Custom transformation.
The Designer generates the following notification functions:
♦ p_<proc_name>_inputRowNotification(). For more information, see “Input Row
Notification Function” on page 62.
♦ p_<proc_name>_dataBdryRowNotification(). For more information, see “Data Boundary
Notification Function” on page 63.
♦ p_<proc_name>_eofNotification(). For more information, see “End Of File Notification
Function” on page 63.
Input Row Notification Function
The PowerCenter Server calls the p_<proc_name>_inputRowNotification() function when it
passes a row or a block of rows to the Custom transformation. It notes which input group and
partition receives data through the input group handle and partition handle.
Use the following syntax:
INFA_ROWSTATUS
p_<proc_name>_inputRowNotification(INFA_CT_PARTITION_HANDLE Partition,
INFA_CT_INPUTGROUP_HANDLE group);
Input/
Argument Datatype Description
Output
partition INFA_CT_PARTITION_HANDLE Input Partition handle.
group INFA_CT_INPUTGROUP_HANDLE Input Input group handle.
The datatype of the return value is INFA_ROWSTATUS. Use the following values for the
return value:
♦ INFA_ROWSUCCESS. Indicates the function successfully processed the row of data.
♦ INFA_ROWERROR. Indicates the function encountered an error for the row of data. The
PowerCenter Server increments the internal error count. Only return this value when the
data access mode is row.
If the input row notification function returns INFA_ROWERROR in array-based mode,
the PowerCenter Server treats it as a fatal error. If you need to indicate a row in a block has
an error, call the INFA_CTASetInputErrorRowM() or INFA_CTASetInputErrorRowU()
function.
♦ INFA_FATALERROR. Indicates the function encountered a fatal error for the row of data
or the block of data. The PowerCenter Server fails the session.
62 Chapter 3: Custom Transformation Functions
Data Boundary Notification Function
The PowerCenter Server calls the p_<proc_name>_dataBdryNotification() function when it
passes a commit or rollback row to a partition.
Use the following syntax:
INFA_STATUS p_<proc_name>_dataBdryNotification(INFA_CT_PARTITION_HANDLE
transformation, INFA_CTDataBdryType dataBoundaryType);
Input/
Argument Datatype Description
Output
transformation INFA_CT_PARTITION_HANDLE Input Partition handle.
dataBoundaryType INFA_CTDataBdryType Input The PowerCenter Server uses one of the
following values for the dataBoundaryType
parameter:
- eBT_COMMIT
- eBT_ROLLBACK
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value. When the function returns INFA_FAILURE, the PowerCenter Server fails
the session.
End Of File Notification Function
The PowerCenter Server calls the p_<proc_name>_eofNotification() function after it passes
the last row to a partition in an input group.
Use the following syntax:
INFA_STATUS p_<proc_name>_eofNotification(INFA_CT_PARTITION_HANDLE
transformation, INFA_CT_INPUTGROUP_HANDLE group);
Input/
Argument Datatype Description
Output
transformation INFA_CT_PARTITION_HANDLE Input Partition handle.
group INFA_CT_INPUTGROUP_HANDLE Input Input group handle.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value. When the function returns INFA_FAILURE, the PowerCenter Server fails
the session.
Deinitialization Functions
The PowerCenter Server calls the deinitialization functions after it processes data for the
Custom transformation. Use the deinitialization functions to write processes you want the
PowerCenter Server to run after it passes all rows of data to the Custom transformation.
Generated Functions 63
The Designer generates the following deinitialization functions:
♦ p_<proc_name>_partitionDeinit(). For more information, see “Partition Deinitialization
Function” on page 64.
♦ p_<proc_name>_procDeinit(). For more information, see “Procedure Deinitialization
Function” on page 64.
♦ m_<module_name>_moduleDeinit(). For more information, see “Module
Deinitialization Function” on page 65.
Partition Deinitialization Function
The PowerCenter Server calls the p_<proc_name>_partitionDeinit() function after it calls the
p_<proc_name>_eofNotification() or p_<proc_name>_abortNotification() function. The
PowerCenter Server calls this function once for each partition of the Custom transformation.
Use the following syntax:
INFA_STATUS p_<proc_name>_partitionDeinit(INFA_CT_PARTITION_HANDLE
partition);
Input/
Argument Datatype Description
Output
partition INFA_CT_PARTITION_HANDLE Input Partition handle.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value. When the function returns INFA_FAILURE, the PowerCenter Server fails
the session.
Procedure Deinitialization Function
The PowerCenter Server calls the p_<proc_name>_procDeinit() function after it calls the
p_<proc_name>_partitionDeinit() function for all partitions of each Custom transformation
instance that uses this procedure in the mapping.
Use the following syntax:
INFA_STATUS p_<proc_name>_procDeinit(INFA_CT_PROCEDURE_HANDLE procedure,
INFA_STATUS sessionStatus);
Input/
Argument Datatype Description
Output
procedure INFA_CT_PROCEDURE_HANDLE Input Procedure handle.
sessionStatus INFA_STATUS Input The PowerCenter Server uses one of the
following values for the sessionStatus
parameter:
- INFA_SUCCESS. Indicates the session
succeeded.
- INFA_FAILURE. Indicates the session
failed.
64 Chapter 3: Custom Transformation Functions
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value. When the function returns INFA_FAILURE, the PowerCenter Server fails
the session.
Module Deinitialization Function
The PowerCenter Server calls the m_<module_name>_moduleDeinit() function after it runs
the post-session tasks. It calls this function, once for a module, after all other functions.
Use the following syntax:
INFA_STATUS m_<module_name>_moduleDeinit(INFA_CT_MODULE_HANDLE module,
INFA_STATUS sessionStatus);
Input/
Argument Datatype Description
Output
module INFA_CT_MODULE_HANDLE Input Module handle.
sessionStatus INFA_STATUS Input The PowerCenter Server uses one of the
following values for the sessionStatus
parameter:
- INFA_SUCCESS. Indicates the session
succeeded.
- INFA_FAILURE. Indicates the session
failed.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value. When the function returns INFA_FAILURE, the PowerCenter Server fails
the session.
Generated Functions 65
API Functions
PowerCenter provides a set of API functions that you can use to develop your transformation
logic. When the Designer generates the source code files, it includes the generated functions
in the source code. Add API functions to your code to implement the transformation logic.
The procedure uses the API functions to interface with the PowerCenter Server. You must
code API functions in the procedure C file. Optionally, you can also code the module C file.
Informatica provides the following groups of API functions:
♦ Set data access mode. See “Set Data Access Mode Function” on page 66.
♦ Navigation. See “Navigation Functions” on page 67.
♦ Property. See “Property Functions” on page 70.
♦ Rebind datatype. See “Rebind Datatype Functions” on page 76.
♦ Data handling (row-based mode). See “Data Handling Functions (Row-Based Mode)” on
page 78.
♦ Set pass through port. See “Set Pass Through Port Function” on page 81.
♦ Output notification. See “Output Notification Function” on page 82.
♦ Data boundary output notification. See “Data Boundary Output Notification Function”
on page 82.
♦ Error. See “Error Functions” on page 83.
♦ Session log message. See “Session Log Message Functions” on page 84.
♦ Increment error count. See “Increment Error Count Function” on page 85.
♦ Is terminated. See “Is Terminated Function” on page 85.
♦ Blocking logic. See “Blocking Logic Functions” on page 86.
♦ Pointer. See “Pointer Functions” on page 87.
♦ Change string mode. See “Change String Mode Function” on page 87.
♦ Set data code page. See “Set Data Code Page Function” on page 88.
♦ Row strategy (row-based mode). See “Row Strategy Functions (Row-Based Mode)” on
page 89.
♦ Change default row strategy. See “Change Default Row Strategy Function” on page 90.
Informatica also provides array-based API Functions. For more information about array-based
API functions, see “Array-Based API Functions” on page 91.
Set Data Access Mode Function
By default, the PowerCenter Server passes data to the Custom transformation procedure one
row at a time. However, you can use the INFA_CTSetDataAccessMode() function to change
the data access mode to array-based. When you set the data access mode to array-based, the
PowerCenter Server passes multiple rows to the procedure as a block in an array.
66 Chapter 3: Custom Transformation Functions
When you set the data access mode to array-based, you must use the array-based versions of
the data handling functions and row strategy functions. When you use a row-based data
handling or row strategy function and you switch to array-based mode, you will get
unexpected results. For example, the DLL or shared library might crash.
You can only use this function in the procedure initialization function.
If you do not use this function in the procedure code, the data access mode is row-based.
However, when you want the data access mode to be row-based, Informatica recommends you
include this function and set the access mode to row-based.
For more information about the array-based functions, see “Array-Based API Functions” on
page 91.
Use the following syntax:
INFA_STATUS INFA_CTSetDataAccessMode( INFA_CT_PROCEDURE_HANDLE procedure,
INFA_CT_DATA_ACCESS_MODE mode );
Input/
Argument Datatype Description
Output
procedure INFA_CT_PROCEDURE_HANDLE Input Procedure name.
mode INFA_CT_DATA_ACCESS_MODE Input Data access mode.
Use the following values for the mode
parameter:
- eDA_ROW
- eDA_ARRAY
Navigation Functions
Use the navigation functions when you want the procedure to navigate through the handle
hierarchy. For more information about handles, see “Working with Handles” on page 52.
PowerCenter provides the following navigation functions:
♦ INFA_CTGetAncestorHandle(). For more information, see “Get Ancestor Handle
Function” on page 67.
♦ INFA_CTGetChildrenHandles(). For more information, see “Get Children Handles
Function” on page 68.
♦ INFA_CTGetInputPortHandle(). For more information, see “Get Port Handle
Functions” on page 69.
♦ INFA_CTGetOutputPortHandle(). For more information, see “Get Port Handle
Functions” on page 69.
Get Ancestor Handle Function
Use the INFA_CTGetAncestorHandle() function when you want the procedure to access a
parent handle of a given handle.
API Functions 67
Use the following syntax:
INFA_CT_HANDLE INFA_CTGetAncestorHandle(INFA_CT_HANDLE handle,
INFA_CTHandleType returnHandleType);
Input/
Argument Datatype Description
Output
handle INFA_CT_HANDLE Input Handle name.
returnHandleType INFA_CTHandleType Input Return handle type.
Use the following values for the returnHandleType
parameter:
- PROCEDURETYPE
- TRANSFORMATIONTYPE
- PARTITIONTYPE
- INPUTGROUPTYPE
- OUTPUTGROUPTYPE
- INPUTPORTTYPE
- OUTPUTPORTTYPE
The handle parameter specifies the handle whose parent you want the procedure to access.
The PowerCenter Server returns INFA_CT_HANDLE if you specify a valid handle in the
function. Otherwise, it returns a null value.
To avoid compilation errors, you must code the procedure to set a handle name to the return
value.
For example, you can enter the following code:
INFA_CT_MODULE_HANDLE module = INFA_CTGetAncestorHandle(procedureHandle,
INFA_CT_HandleType);
Get Children Handles Function
Use the INFA_CTGetChildrenHandles() function when you want the procedure to access the
children handles of a given handle.
Use the following syntax:
INFA_CT_HANDLE* INFA_CTGetChildrenHandles(INFA_CT_HANDLE handle, size_t*
pnChildrenHandles, INFA_CTHandleType returnHandleType);
Argument Datatype Input/Output Description
handle INFA_CT_HANDLE Input Handle name.
68 Chapter 3: Custom Transformation Functions
Argument Datatype Input/Output Description
pnChildrenHandles size_t* Output The PowerCenter Server returns an array of
children handles. The pnChildrenHandles
parameter indicates the number of children
handles in the array.
returnHandleType INFA_CTHandleType Input Use the following values for the returnHandleType
parameter:
- PROCEDURETYPE
- TRANSFORMATIONTYPE
- PARTITIONTYPE
- INPUTGROUPTYPE
- OUTPUTGROUPTYPE
- INPUTPORTTYPE
- OUTPUTPORTTYPE
The handle parameter specifies the handle whose children you want the procedure to access.
The PowerCenter Server returns INFA_CT_HANDLE* when you specify a valid handle in
the function. Otherwise, it returns a null value.
To avoid compilation errors, you must code the procedure to set a handle name to the
returned value.
For example, you can enter the following code:
INFA_CT_PARTITION_HANDLE partition =
INFA_CTGetChildrenHandles(procedureHandle, pnChildrenHandles,
INFA_CT_PARTITION_HANDLE_TYPE);
Get Port Handle Functions
The PowerCenter Server associates the INFA_CT_INPUTPORT_HANDLE with input and
input/output ports, and the INFA_CT_OUTPUTPORT_HANDLE with output and input/
output ports.
PowerCenter provides the following get port handle functions:
♦ INFA_CTGetInputPortHandle(). Use this function when the procedure knows the
output port handle for an input/output port and needs the input port handle.
Use the following syntax:
INFA_CTINFA_CT_INPUTPORT_HANDLE
INFA_CTGetInputPortHandle(INFA_CT_OUTPUTPORT_HANDLE outputPortHandle);
Input/
Argument Datatype Description
Output
outputPortHandle INFA_CT_OUTPUTPORT_HANDLE input Output port handle.
♦ INFA_CTGetOutputPortHandle(). Use this function when the procedure knows the
input port handle for an input/output port and needs the output port handle.
API Functions 69
Use the following syntax:
INFA_CT_OUTPUTPORT_HANDLE
INFA_CTGetOutputPortHandle(INFA_CT_INPUTPORT_HANDLE inputPortHandle);
Input/
Argument Datatype Description
Output
inputPortHandle INFA_CT_INPUTPORT_HANDLE input Input port handle.
The PowerCenter Server returns NULL when you use the get port handle functions with
input or output ports.
Property Functions
Use the property functions when you want the procedure to access the Custom
transformation properties. The property functions can access properties on the following tabs
of the Custom transformation:
♦ Ports
♦ Properties
♦ Initialization Properties
♦ Metadata Extensions
♦ Port Attribute Definitions
You can only use these functions in initialization functions. PowerCenter provides the
following property functions:
♦ INFA_CTGetInternalProperty<datatype>(). For more information, see “Get Internal
Property Function” on page 70.
♦ INFA_CTGetAllPropertyNamesM(). For more information, see “Get All External
Property Names (MBCS or Unicode)” on page 74.
♦ INFA_CTGetAllPropertyNamesU(). For more information, see “Get All External
Property Names (MBCS or Unicode)” on page 74.
♦ INFA_CTGetExternalProperty<datatype>M(). For more information, see “Get External
Properties (MBCS or Unicode)” on page 75.
♦ INFA_CTGetExternalProperty<datatype>U(). For more information, see “Get External
Properties (MBCS or Unicode)” on page 75.
Get Internal Property Function
PowerCenter provides functions to access the port attributes specified on the ports tab, and
properties specified for attributes on the Properties tab of the Custom transformation.
The PowerCenter Server associates every port and property attribute with a property ID. You
must specify the property ID in the procedure to access the values specified for the attributes.
For more information about property IDs, see Table 3-5 on page 71. For the handle
70 Chapter 3: Custom Transformation Functions
parameter, specify a handle name from the handle hierarchy. The PowerCenter Server fails the
session if the handle name is invalid.
Use the following functions when you want the procedure to access the properties:
♦ INFA_CTGetInternalPropertyStringM(). Accesses a value of type string in MBCS for a
given property ID.
Use the following syntax:
INFA_STATUS INFA_CTGetInternalPropertyStringM( INFA_CT_HANDLE handle,
size_t propId, const char** psPropValue );
♦ INFA_CTGetInternalPropertyStringU(). Accesses a value of type string in Unicode for a
given property ID.
Use the following syntax:
INFA_STATUS INFA_CTGetInternalPropertyStringU( INFA_CT_HANDLE handle,
size_t propId, const INFA_UNICHAR** psPropValue );
♦ INFA_CTGetInternalPropertyInt32(). Accesses a value of type integer for a given
property ID.
Use the following syntax:
INFA_STATUS INFA_CTGetInternalPropertyInt32( INFA_CT_HANDLE handle,
size_t propId, INFA_INT32* pnPropValue );
♦ INFA_CTGetInternalPropertyBool(). Accesses a value of type Boolean for a given
property ID.
Use the following syntax:
INFA_STATUS INFA_CTGetInternalPropertyBool( INFA_CT_HANDLE handle, size_t
propId, INFA_Boolean* pbPropValue );
♦ INFA_CTGetInternalPropertyINFA_PTR(). Accesses a pointer to a value for a given
property ID.
Use the following syntax:
INFA_STATUS INFA_CTGetInternalPropertyINFA_PTR( INFA_CT_HANDLE handle,
size_t propId, INFA_PTR* pvPropValue );
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
Table 3-5 lists the handle properties IDs:
Table 3-5. Handle Property IDs
Handle Property ID Datatype Description
INFA_CT_MODULE_NAME String Specifies the module name.
INFA_CT_SESSION_INFA_VERSION String Specifies the Informatica version.
INFA_CT_SESSION_CODEPAGE Integer Specifies the PowerCenter Server code page.
API Functions 71
Table 3-5. Handle Property IDs
Handle Property ID Datatype Description
INFA_CT_SESSION_DATAMOVEMENT_MODE Integer Specifies the data movement mode. The
PowerCenter Server returns one of the following
values:
- eASM_MBCS
- eASM_UNICODE
INFA_CT_SESSION_VALIDATE_CODEPAGE Boolean Specifies whether the PowerCenter Server
enforces code page validation.
INFA_CT_SESSION_PROD_INSTALL_DIR String Specifies the PowerCenter Server installation
directory.
INFA_CT_HIGH_PRECISION_MODE Boolean Specifies whether session is configured for high
precision.
INFA_CT_MODULE_RUNTIME_DIR String Specifies the runtime directory for the DLL or
shared library.
INFA_CT_IS_UPD_STR_ALLOWED Boolean Specifies whether the Update Strategy
Transformation property is selected in the
transformation.
INFA_CT_PROCEDURE_NAME String Specifies the Custom transformation procedure
name.
INFA_CT_TRANS_INSTANCE_NAME String Specifies the Custom transformation instance
name.
INFA_CT_TRANS_TRACE_LEVEL Integer Specifies the tracing level. The PowerCenter
Server returns one of the following values:
- eTRACE_TERSE
- eTRACE_NORMAL
- eTRACE_VERBOSE_INIT
- eTRACE_VERBOSE_DATA
INFA_CT_TRANS_MAY_BLOCK_DATA Boolean Specifies if the PowerCenter Server allows the
procedure to block input data in the current
session.
INFA_CT_TRANS_MUST_BLOCK_DATA Boolean Specifies if the Inputs Must Block Custom
transformation property is selected.
INFA_CT_TRANS_ISACTIVE Boolean Specifies whether the Custom transformation is
an active or passive transformation.
INFA_CT_TRANS_ISPARTITIONABLE Boolean Specifies if you can partition sessions that use
this Custom transformation.
INFA_CT_TRANS_IS_UPDATE_STRATEGY Boolean Specifies if the Custom transformation behaves
like an Update Strategy transformation.
INFA_CT_TRANS_DEFAULT_UPDATE_STRATE Integer Specifies the default update strategy.
GY - eDUS_INSERT
- eDUS_UPDATE
- eDUS_DELETE
- eDUS_REJECT
- eDUS_PASSTHROUGH
72 Chapter 3: Custom Transformation Functions
Table 3-5. Handle Property IDs
Handle Property ID Datatype Description
INFA_CT_TRANS_NUM_PARTITIONS Integer Specifies the number of partitions in the sessions
that use this Custom transformation.
INFA_CT_TRANS_DATACODEPAGE Integer Specifies the code page in which the
PowerCenter Server passes data to the Custom
transformation. Use the set data code page
function if you want the Custom transformation to
access data in a different code page. For more
information, see “Set Data Code Page Function”
on page 88.
INFA_CT_TRANS_TRANSFORM_SCOPE Integer Specifies the transformation scope in the Custom
transformation. The PowerCenter Server returns
one of the following values:
- eTS_ROW
- eTS_TRANSACTION
- eTS_ALLINPUT
INFA_CT_TRANS_GENERATE_TRANSACT Boolean Specifies if the Generate Transaction property is
enabled. The PowerCenter Server returns one of
the following values:
- INFA_TRUE
- INFA_FALSE
INFA_CT_TRANS_OUTPUT_IS_REPEATABLE Integer Specifies whether the Custom transformation
produces data in the same order in every session
run. The PowerCenter Server returns one of the
following values:
- eOUTREPEAT_NEVER = 1
- eOUTREPEAT_ALWAYS = 2
- eOUTREPEAT_BASED_ON_INPUT_ORDER =
3
INFA_CT_TRANS_FATAL_ERROR Boolean Specifies if the Custom Transformation caused a
fatal error. The PowerCenter Server returns one
of the following values:
- INFA_TRUE
- INFA_FALSE
INFA_CT_GROUP_NAME String Specifies the group name.
INFA_CT_GROUP_ISCONNECTED Boolean Specifies if all ports in a group are connected to
another transformation.
INFA_CT_PORT_NAME String Specifies the port name.
API Functions 73
Table 3-5. Handle Property IDs
Handle Property ID Datatype Description
INFA_CT_PORT_CDATATYPE Integer Specifies the port datatype. The PowerCenter
Server returns one of the following values:
- eINFA_CTYPE_SHORT
- eINFA_CTYPE_INT32
- eINFA_CTYPE_CHAR
- eINFA_CTYPE_RAW
- eINFA_CTYPE_UNICHAR
- eINFA_CTYPE_TIME
- eINFA_CTYPE_FLOAT
- eINFA_CTYPE_DOUBLE
- eINFA_CTYPE_DECIMAL18_FIXED
- eINFA_CTYPE_DECIMAL28_FIXED
- eINFA_CTYPE_INFA_CTDATETIME
INFA_CT_PORT_PRECISION Integer Specifies the port precision.
INFA_CT_PORT_SCALE Integer Specifies the port scale (if applicable).
INFA_CT_PORT_ISMAPPED Boolean Specifies whether the port is linked to other
transformations in the mapping.
INFA_CT_PORT_STORAGESIZE Integer Specifies the internal storage size of the data for a
port. The storage size depends on the datatype of
the port.
INFA_CT_PORT_BOUNDDATATYPE Integer Specifies the port datatype. Use instead of
INFA_CT_PORT_CDATATYPE if you rebind the
port and specify a datatype other than the default.
For more information about rebinding a port, see
“Rebind Datatype Functions” on page 76.
Get All External Property Names (MBCS or Unicode)
PowerCenter provides two functions to access the property names defined on the Metadata
Extensions tab, Initialization Properties tab, and Port Attribute Definitions tab of the Custom
transformation.
Use the following functions when you want the procedure to access the property names:
♦ INFA_CTGetAllPropertyNamesM(). Accesses the property names in MBCS.
Use the following syntax:
INFA_STATUS INFA_CTGetAllPropertyNamesM(INFA_CT_HANDLE handle, const
char*const** paPropertyNames, size_t* pnProperties);
Input/
Argument Datatype Description
Output
handle INFA_CT_HANDLE Input Specify the handle name.
74 Chapter 3: Custom Transformation Functions
Input/
Argument Datatype Description
Output
paPropertyNames const char*const** Output Specifies the property name. The PowerCenter
Server returns an array of property names in
MBCS.
pnProperties size_t* Output Indicates the number of properties in the array.
♦ INFA_CTGetAllPropertyNamesU(). Accesses the property names in Unicode.
Use the following syntax:
INFA_STATUS INFA_CTGetAllPropertyNamesU(INFA_CT_HANDLE handle, const
INFA_UNICHAR*const** pasPropertyNames, size_t* pnProperties);
Input/
Argument Datatype Description
Output
handle INFA_CT_HANDLE Input Specify the handle name.
paPropertyNames const Output Specifies the property name. The PowerCenter
INFA_UNICHAR*const** Server returns an array of property names in
Unicode.
pnProperties size_t* Output Indicates the number of properties in the array.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
Get External Properties (MBCS or Unicode)
PowerCenter provides functions to access the values of the properties defined on the Metadata
Extensions tab, Initialization Properties tab, or Port Attribute Definitions tab of the Custom
transformation.
You must specify the property names in the functions if you want the procedure to access the
values. Use the INFA_CTGetAllPropertyNamesM() or INFA_CTGetAllPropertyNamesU()
functions to access property names. For the handle parameter, specify a handle name from the
handle hierarchy. The PowerCenter Server fails the session if the handle name is invalid.
Note: If you define an initialization property with the same name as a metadata extension, the
PowerCenter Server returns the metadata extension value.
API Functions 75
Use the following functions when you want the procedure to access the values of the
properties:
♦ INFA_CTGetExternalProperty<datatype>M(). Accesses the value of the property in
MBCS. Use the syntax as shown in Table 3-6:
Table 3-6. Property Functions (MBCS)
Property
Syntax
Datatype
INFA_STATUS INFA_CTGetExternalPropertyStringM(INFA_CT_HANDLE String
handle, const char* sPropName, const char** psPropValue);
INFA_STATUS INFA_CTGetExternalPropertyINT32M(INFA_CT_HANDLE Integer
handle, const char* sPropName, INFA_INT32* pnPropValue);
INFA_STATUS INFA_CTGetExternalPropertyBoolM(INFA_CT_HANDLE Boolean
handle, const char* sPropName, INFA_Boolean* pbPropValue);
♦ INFA_CTGetExternalProperty<datatype>U(). Accesses the value of the property in
Unicode. Use the syntax as shown in Table 3-7:
Table 3-7. Property Functions (Unicode)
Property
Syntax
Datatype
INFA_STATUS INFA_CTGetExternalPropertyStringU(INFA_CT_HANDLE String
handle, INFA_UNICHAR* sPropName, INFA_UNICHAR** psPropValue);
INFA_STATUS INFA_CTGetExternalPropertyStringU(INFA_CT_HANDLE Integer
handle, INFA_UNICHAR* sPropName, INFA_INT32* pnPropValue);
INFA_STATUS INFA_CTGetExternalPropertyStringU(INFA_CT_HANDLE Boolean
handle, INFA_UNICHAR* sPropName, INFA_Boolean* pbPropValue);
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
Rebind Datatype Functions
PowerCenter allows you to rebind a port with a datatype other than the default datatype. Use
the rebind datatype functions if you want the procedure to access data in a datatype other
than the default datatype. You must rebind the port with a compatible datatype.
You can only use these functions in the initialization functions.
76 Chapter 3: Custom Transformation Functions
Consider the following rules when you rebind the datatype for an output or input/output
port:
♦ You must use the data handling functions to set the data and the indicator for that port.
Use the INFA_CTSetData() and INFA_CTSetIndicator() functions in row-based mode,
and use the INFA_CTASetData() function in array-based mode.
♦ Do not call the INFA_CTSetPassThruPort() function for the output port.
Table 3-8 lists compatible datatypes:
Table 3-8. Compatible Datatypes
Default Datatype Compatible With
Char Unichar
Unichar Char
Date INFA_DATETIME
Use the following syntax:
struct INFA_DATETIME
{
int nYear;
int nMonth;
int nDay;
int nHour;
int nMinute;
int nSecond;
int nNanoSecond;
}
Dec18 Char, Unichar
Dec28 Char, Unichar
API Functions 77
PowerCenter provides the following rebind datatype functions:
♦ INFA_CTRebindInputDataType(). Rebinds the input port. Use the following syntax:
INFA_STATUS INFA_CTRebindInputDataType(INFA_CT_INPUTPORT_HANDLE
portHandle, INFA_CDATATYPE datatype);
♦ INFA_CTRebindOutputDataType(). Rebinds the output port. Use the following syntax:
INFA_STATUS INFA_CTRebindOutputDataType(INFA_CT_OUTPUTPORT_HANDLE
portHandle, INFA_CDATATYPE datatype);
Input/
Argument Datatype Description
Output
portHandle INFA_CT_OUTPUTPORT_HANDLE Input Output port handle.
datatype INFA_CDATATYPE Input The datatype with which you rebind the
port. Use the following values for the
datatype parameter:
- eINFA_CTYPE_SHORT
- eINFA_CTYPE_INT32
- eINFA_CTYPE_CHAR
- eINFA_CTYPE_RAW
- eINFA_CTYPE_UNICHAR
- eINFA_CTYPE_TIME
- eINFA_CTYPE_FLOAT
- eINFA_CTYPE_DOUBLE
- eINFA_CTYPE_DECIMAL18_FIXED
- eINFA_CTYPE_DECIMAL28_FIXED
- eINFA_CTYPE_INFA_CTDATETIME
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
Data Handling Functions (Row-Based Mode)
When the PowerCenter Server calls the input row notification function, it notifies the
procedure that the procedure can access a row or block of data. However, to get data from the
input port, modify it, and set data in the output port, you must use the data handling
functions in the input row notification function. When the data access mode is row-based,
use the row-based data handling functions.
Include the INFA_CTGetData<datatype>() function to get the data from the input port and
INFA_CTSetData() function to set the data in the output port. Include the
INFA_CTGetIndicator() or INFA_CTGetLength() function if you want the procedure to
verify before you get the data if the port has a null value or an empty string.
PowerCenter provides the following data handling functions:
♦ INFA_CTGetData<datatype>(). For more information, see “Get Data Functions (Row-
Based Mode)” on page 79.
♦ INFA_CTSetData(). For more information, see “Set Data Function (Row-Based Mode)”
on page 79.
78 Chapter 3: Custom Transformation Functions
♦ INFA_CTGetIndicator(). For more information, see “Indicator Functions (Row-Based
Mode)” on page 80.
♦ INFA_CTSetIndicator(). For more information, see “Indicator Functions (Row-Based
Mode)” on page 80.
♦ INFA_CTGetLength(). For more information, see “Length Functions” on page 81.
♦ INFA_CTSetLength(). For more information, see “Length Functions” on page 81.
Get Data Functions (Row-Based Mode)
Use the INFA_CTGetData<datatype>() functions to retrieve data for the port the function
specifies.
You must modify the function name depending on the datatype of the port you want the
procedure to access.
Table 3-9 lists the INFA_CTGetData<datatype>() function syntax and the datatype of the
return value:
Table 3-9. Get Data Functions
Return Value
Syntax
Datatype
void* INFA_CTGetDataVoid(INFA_CT_INPUTPORT_HANDLE dataHandle); Data void
pointer to the
return value
char* INFA_CTGetDataStringM(INFA_CT_INPUTPORT_HANDLE String (MBCS)
dataHandle);
IUNICHAR* INFA_CTGetDataStringU(INFA_CT_INPUTPORT_HANDLE String
dataHandle); (Unicode)
INFA_INT32 INFA_CTGetDataINT32(INFA_CT_INPUTPORT_HANDLE Integer
dataHandle);
double INFA_CTGetDataDouble(INFA_CT_INPUTPORT_HANDLE Double
dataHandle);
INFA_CT_RAWDATE INFA_CTGetDataDate(INFA_CT_INPUTPORT_HANDLE Raw date
dataHandle);
INFA_CT_RAWDEC18 INFA_CTGetDataRawDec18( Decimal BLOB
INFA_CT_INPUTPORT_HANDLE dataHandle); (precision 18)
INFA_CT_RAWDEC28 INFA_CTGetDataRawDec28( Decimal BLOB
INFA_CT_INPUTPORT_HANDLE dataHandle); (precision 28)
INFA_CT_DATETIME Datetime
INFA_CTGetDataDateTime(INFA_CT_INPUTPORT_HANDLE dataHandle);
Set Data Function (Row-Based Mode)
Use the INFA_CTSetData() function when you want the procedure to pass a value to an
output port.
API Functions 79
Use the following syntax:
INFA_STATUS INFA_CTSetData(INFA_CT_OUTPUTPORT_HANDLE dataHandle, void*
data);
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
Note: If you use the INFA_CTSetPassThruPort() function on an input/output port, do not
use set the data or indicator for that port.
Indicator Functions (Row-Based Mode)
Use the indicator functions when you want the procedure to get the indicator for an input
port or to set the indicator for an output port. The indicator for a port indicates whether the
data is valid, null, or truncated.
PowerCenter provides the following indicator functions:
♦ INFA_CTGetIndicator(). Gets the indicator for an input port. Use the following syntax:
INFA_INDICATOR INFA_CTGetIndicator(INFA_CT_INPUTPORT_HANDLE dataHandle);
The return value datatype is INFA_INDICATOR. Use the following values for
INFA_INDICATOR:
− INFA_DATA_VALID. Indicates the data is valid.
− INFA_NULL_DATA. Indicates a null value.
− INFA_DATA_TRUNCATED. Indicates the data has been truncated.
♦ INFA_CTSetIndicator(). Sets the indicator for an output port. Use the following syntax:
INFA_STATUS INFA_CTSetIndicator(INFA_CT_OUTPUTPORT_HANDLE dataHandle,
INFA_INDICATOR indicator);
Input/
Argument Datatype Description
Output
dataHandle INFA_CT_OUTPUTPORT_HANDLE Input Output port handle.
indicator INFA_INDICATOR Input The indicator value for the output port. Use
one of the following values:
- INFA_DATA_VALID. Indicates the data is
valid.
- INFA_NULL_DATA. Indicates a null value.
- INFA_DATA_TRUNCATED. Indicates the
data has been truncated.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE
for the return value.
Note: If you use the INFA_CTSetPassThruPort() function on an input/output port, do not
set the data or indicator for that port.
80 Chapter 3: Custom Transformation Functions
Length Functions
Use the length functions when you want the procedure to access the length of a string or
binary input port, or to set the length of a binary or string output port.
Use the following length functions:
♦ INFA_CTGetLength(). You can use this function for string and binary ports only. The
PowerCenter Server returns the length as the number of characters including trailing
spaces. Use the following syntax:
INFA_UINT32 INFA_CTGetLength(INFA_CT_INPUTPORT_HANDLE dataHandle);
The return value datatype is INFA_UINT32. Use a value between zero and 2GB for the
return value.
♦ INFA_CTSetLength(). When the Custom transformation contains a binary or string
output port, you must use this function to set the length of the data, including trailing
spaces. Verify you the length you set for string and binary ports is not greater than the
precision for that port. If you set the length greater than the port precision, you get
unexpected results. For example, the session may fail.
Use the following syntax:
INFA_STATUS INFA_CTSetLength(INFA_CT_OUTPUTPORT_HANDLE dataHandle,
IUINT32 length);
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE
for the return value.
Set Pass Through Port Function
Use the INFA_CTSetPassThruPort() function when you want the PowerCenter Server to pass
data from an input port to an output port without modifying the data. When you use the
INFA_CTSetPassThruPort() function, the PowerCenter Server passes the data to the output
port when it calls the input row notification function.
Consider the following rules and guidelines when you use the set pass through port function:
♦ Only use this function in an initialization function.
♦ If the procedure includes this function, do not include the INFA_CTSetData(),
INFA_CTSetLength, INFA_CTSetIndicator(), or INFA_CTASetData() functions to pass
data to the output port.
♦ In row-based mode, you can only include this function when the transformation scope is
Row. When the transformation scope is Transaction or All Input, this function returns
INFA_FAILURE.
♦ In row-based mode, when you use this function to output multiple rows for a given input
row, every output row contains the data that is passed through from the input port.
♦ In array-based mode, you can only use this function for passive Custom transformations.
You must verify that the datatype, precision, and scale are the same for the input and output
ports. The PowerCenter Server fails the session if the datatype, precision, or scale are not the
same for the input and output ports you specify in the INFA_CTSetPassThruPort() function.
API Functions 81
Use the following syntax:
INFA_STATUS INFA_CTSetPassThruPort(INFA_CT_OUTPUTPORT_HANDLE outputport,
INFA_CT_INPUTPORT_HANDLE inputport)
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
Output Notification Function
When you want the procedure to output a row to the PowerCenter Server, use the
INFA_CTOutputNotification() function. Only include this function for active Custom
transformations. For passive Custom transformations, the procedure outputs a row to the
PowerCenter Server when the input row notification function gives a return value. If the
procedure calls this function for a passive Custom transformation, the PowerCenter Server
ignores the function.
Note: When the transformation scope is Row, you can only include this function in the input
row notification function. If you include it somewhere else, it returns a failure.
Use the following syntax:
INFA_ROWSTATUS INFA_CTOutputNotification(INFA_CT_OUTPUTGROUP_HANDLE
group);
Input/
Argument Datatype Description
Output
group INFA_CT_OUTPUT_GROUP_HANDLE Input Output group handle.
The return value datatype is INFA_ROWSTATUS. Use the following values for the return
value:
♦ INFA_ROWSUCCESS. Indicates the function successfully processed the row of data.
♦ INFA_ROWERROR. Indicates the function encountered an error for the row of data. The
PowerCenter Server increments the internal error count.
♦ INFA_FATALERROR. Indicates the function encountered a fatal error for the row of
data. The PowerCenter Server fails the session.
Note: When the procedure code calls the INFA_CTOutputNotification() function, you must
verify that all pointers in an output port handle point to valid data. When a pointer does not
point to valid data, the PowerCenter Server might shut down unexpectedly.
Data Boundary Output Notification Function
Include the INFA_CTDataBdryOutputNotification() function when you want the procedure
to output a commit or rollback transaction.
When you use this function, you must select the Generate Transaction property for this
Custom transformation. If you do not select this property, the PowerCenter Server fails the
session.
82 Chapter 3: Custom Transformation Functions
Use the following syntax:
INFA_STATUS INFA_CTDataBdryOutputNotification(INFA_CT_PARTITION_HANDLE
handle, INFA_CTDataBdryType dataBoundaryType);
Input/
Argument Datatype Description
Output
handle INFA_CT_PARTITION_HANDLE Input Handle name.
dataBoundaryType INFA_CTDataBdryType Input The transaction type.
Use the following values for the
dataBoundaryType parameter:
- eBT_COMMIT
- eBT_ROLLBACK
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
Error Functions
Use the error functions to access procedure errors. The PowerCenter Server returns the most
recent error.
PowerCenter provides the following error functions:
♦ INFA_CTGetErrorMsgM(). Gets the error message in MBCS. Use the following syntax:
const char* INFA_CTGetErrorMsgM();
♦ INFA_CTGetErrorMsgU(). Gets the error message in Unicode. Use the following syntax:
const IUNICHAR* INFA_CTGetErrorMsgU();
API Functions 83
Session Log Message Functions
Use the session log message functions when you want the procedure to log a message in the
session log in either Unicode or MBCS.
PowerCenter provides the following session log message functions:
♦ INFA_CTLogMessageU(). Logs a message in Unicode.
Use the following syntax:
void INFA_CTLogMessageU(INFA_CT_ErrorSeverityLevel errorseverityLevel,
INFA_UNICHAR* msg)
Input/
Argument Datatype Description
Output
errorSeverityLevel INFA_CT_ErrorSeverityLevel Input The severity level of the error message
that you want the PowerCenter Server to
write in the session log. Use the following
values for the errorSeverityLevel
parameter:
- eESL_LOG
- eESL_DEBUG
- eESL_ERROR
msg INFA_UNICHAR* Input Enter the text of the message in Unicode
in quotes.
♦ INFA_CTLogMessageM(). Logs a message in MBCS.
Use the following syntax:
void INFA_CTLogMessageM(INFA_CT_ErrorSeverityLevel errorSeverityLevel,
char* msg)
Input/
Argument Datatype Description
Output
errorSeverityLevel INFA_CT_ErrorSeverityLevel Input The severity level of the error message
that you want the PowerCenter Server to
write in the session log. Use the following
values for the errorSeverityLevel
parameter:
- eESL_LOG
- eESL_DEBUG
- eESL_ERROR
msg char* Input Enter the text of the message in MBCS in
quotes.
84 Chapter 3: Custom Transformation Functions
Increment Error Count Function
Use the INFA_CTIncrementErrorCount() function when you want to increase the error
count for the session.
Use the following syntax:
INFA_STATUS INFA_CTIncrementErrorCount(INFA_CT_PARTITION_HANDLE
transformation, size_t nErrors, INFA_STATUS* pStatus);
Input/
Argument Datatype Description
Output
transformation INFA_CT_PARTITION_HANDLE Input Partition handle.
nErrors size_t Input The PowerCenter Server increments the
error count by nErrors for the given
transformation instance.
pStatus INFA_STATUS* Input The PowerCenter Server uses
INFA_FAILURE for the pStatus parameter
when the error count exceeds the error
threshold and fails the session.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
Is Terminated Function
Use the INFA_CTIsTerminated() function when you want the procedure to check if the
PowerCenter Client has requested the PowerCenter Server to stop the session. You might call
this function if the procedure includes a time-consuming process.
Use the following syntax:
INFA_CTTerminateType INFA_CTIsTerminated(INFA_CT_PARTITION_HANDLE
handle);
Input/
Argument Datatype Description
Output
handle INFA_CT_PARTITION_HANDLE input Partition handle.
The return value datatype is INFA_CTTerminateType. The PowerCenter Server returns one
of the following values:
♦ eTT_NOTTERMINATED. Indicates the PowerCenter Client has not requested to stop
the session.
♦ eTT_ABORTED. Indicates the PowerCenter Server aborted the session.
♦ eTT_STOPPED. Indicates the PowerCenter Server failed the session.
API Functions 85
Blocking Logic Functions
When the Custom transformation contains multiple input groups, you can write code to
block the incoming data on an input group. For more information about blocking data, see
“Blocking Input Data” on page 32.
Consider the following rules when you use the blocking functions:
♦ You can block at most n-1 input groups.
♦ You cannot block an input group that is already blocked.
♦ You cannot block an input group when it receives data from the same source as another
input group.
♦ You cannot unblock an input group that is already unblocked.
PowerCenter provides the following blocking logic functions:
♦ INFA_CTBlockInputFlow(). Allows the procedure to block an input group.
Use the following syntax:
INFA_STATUS INFA_CTBlockInputFlow(INFA_CT_INPUTGROUP_HANDLE group);
♦ INFA_CTUnblockInputFlow(). Allows the procedure to unblock an input group.
Use the following syntax:
INFA_STATUS INFA_CTUnblockInputFlow(INFA_CT_INPUTGROUP_HANDLE group);
Input/
Argument Datatype Description
Output
group INFA_CT_INPUTGROUP_HANDLE Input Input group handle.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
Verify Blocking
When you use the INFA_CTBlockInputFlow() and INFA_CTUnblockInputFlow() functions
in the procedure code, verify the procedure checks whether or not the PowerCenter Server
allows the Custom transformation to block incoming data. To do this, check the value of the
INFA_CT_TRANS_MAY_BLOCK_DATA propID using the
INFA_CTGetInternalPropertyBool() function.
When the value of the INFA_CT_TRANS_MAY_BLOCK_DATA propID is FALSE, the
procedure should either not use the blocking functions, or it should return a fatal error and
stop the session.
If the procedure code uses the blocking functions when the PowerCenter Server does not
allow the Custom transformation to block data, the PowerCenter Server might fail the
session.
86 Chapter 3: Custom Transformation Functions
Pointer Functions
Use the pointer functions when you want the PowerCenter Server to create and access
pointers to an object or a structure.
PowerCenter provides the following pointer functions:
♦ INFA_CTGetUserDefinedPointer(). Allows the procedure to access an object or structure
during run time.
Use the following syntax:
void* INFA_CTGetUserDefinedPointer(INFA_CT_HANDLE handle)
Input/
Argument Datatype Description
Output
handle INFA_CT_HANDLE Input Handle name.
♦ INFA_CTSetUserDefinedPointer(). Allows the procedure to associate an object or a
structure with any handle the PowerCenter Server provides. To reduce processing
overhead, include this function in the initialization functions.
Use the following syntax:
INFA_CTSetUserDefinedPointer(INFA_CT_HANDLE handle, void* userPointer)
Input/
Argument Datatype Description
Output
handle INFA_CT_HANDLE Input Handle name.
userPointer void* Input User pointer.
You must substitute a valid handle for INFA_CT_HANDLE.
Change String Mode Function
When the PowerCenter Server runs in Unicode mode, it passes data to the procedure in UCS-
2 by default. When it runs in ASCII mode, it passes data in ASCII by default. Use the
INFA_CTChangeStringMode() function if you want to change the default string mode for
the procedure. When you change the default string mode to MBCS, the PowerCenter Server
passes data in the PowerCenter Server code page. Use the INFA_CTSetDataCodePageID()
function if you want to change the code page. For more information about changing the code
page ID, see “Set Data Code Page Function” on page 88.
When your procedure includes the INFA_CTChangeStringMode() function, the
PowerCenter Server changes the string mode for all ports in each Custom transformation.
You can only use these functions in the initialization functions.
API Functions 87
Use the following syntax:
INFA_STATUS INFA_CTChangeStringMode(INFA_CT_PROCEDURE_HANDLE procedure,
INFA_CTStringMode stringMode);
Input/
Argument Datatype Description
Output
procedure INFA_CT_PROCEDURE_HANDLE Input Procedure handle name.
stringMode INFA_CTStringMode Input Specifies the string mode that you want the
PowerCenter Server to use. Use the following values
for the stringMode parameter:
- eASM_UNICODE. Use this when the PowerCenter
Server runs in ASCII mode and you want the
procedure to access data in Unicode.
- eASM_MBCS. Use this when the PowerCenter
Server runs in Unicode mode and you want the
procedure to access data in MBCS.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
Set Data Code Page Function
Use the INFA_CTSetDataCodePageID() when you want the PowerCenter Server to pass data
to the Custom transformation in a code page other than the PowerCenter Server code page.
You can only use this function in the procedure initialization function.
Use the following syntax:
INFA_STATUS INFA_CTSetDataCodePageID(INFA_CT_TRANSFORMATION_HANDLE
transformation, int dataCodePageID);
Input/
Argument Datatype Description
Output
transformation INFA_CT_TRANSFORMATION_HANDLE Input Transformation handle name.
dataCodePageID int Input Specifies the code page you want the
PowerCenter Server to pass data in.
For valid values for the
dataCodePageID parameter, see
“Code Pages” in the Installation and
Configuration Guide.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
88 Chapter 3: Custom Transformation Functions
Row Strategy Functions (Row-Based Mode)
The row strategy functions allow you to access and configure the update strategy for each row.
PowerCenter provides the following row strategy functions:
♦ INFA_CTGetRowStrategy(). Allows the procedure to get the update strategy for a row.
Use the following syntax:
INFA_STATUS INFA_CTGetRowStrategy(INFA_CT_INPUTGROUP_HANDLE group,
INFA_CTUpdateStrategy updateStrategy);
Input/
Argument Datatype Description
Output
group INFA_CT_INPUTGROUP_HANDLE Input Input group handle.
updateStrategy INFA_CT_UPDATESTRATEGY Input The update strategy for the input port.
The PowerCenter Server uses the
following values:
- eUS_INSERT = 0
- eUS_UPDATE = 1
- eUS_DELETE = 2
- eUS_REJECT = 3
♦ INFA_CTSetRowStrategy(). Sets the update strategy for each row. This will override the
INFA_CTChangeDefaultRowStrategy function.
Use the following syntax:
INFA_STATUS INFA_CTSetRowStrategy(INFA_CT_OUTPUTGROUP_HANDLE group,
INFA_CT_UPDATESTRATEGY updateStrategy);
Input/
Argument Datatype Description
Output
group INFA_CT_OUTPUTGROUP_HANDLE Input Output group handle.
updateStrategy INFA_CT_UPDATESTRATEGY Input The update strategy you want to set for
the output port. Use one of the
following values:
- eUS_INSERT = 0
- eUS_UPDATE = 1
- eUS_DELETE = 2
- eUS_REJECT = 3
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
API Functions 89
Change Default Row Strategy Function
By default, the row strategy for a Custom transformation is pass through when the
transformation scope is Row. When the transformation scope is Transaction or All Input, the
row strategy is the same value as the Treat Source Rows As session property by default.
For example, in your mapping you have an Update Strategy transformation followed by a
Custom transformation with Row transformation scope. The Update Strategy transformation
flags the rows for update, insert, or delete. When the PowerCenter Server passes a row to the
Custom transformation, the Custom transformation retains the flag since its row strategy is
pass through.
However, PowerCenter allows you to change the row strategy of a Custom transformation.
Use the INFA_CTChangeDefaultRowStrategy() function to change the default row strategy
at the transformation level. For example, when you change the default row strategy of a
Custom transformation to insert, the PowerCenter Server flags all the rows that pass through
this transformation for insert.
Note: The PowerCenter Server returns INFA_FAILURE if the session is not in data-driven
mode.
Use the following syntax:
INFA_STATUS INFA_CTChangeDefaultRowStrategy(INFA_CT_TRANSFORMATION_HANDLE
transformation, INFA_CT_DefaultUpdateStrategy defaultUpdateStrategy);
Input/
Argument Datatype Description
Output
transformation INFA_CT_TRANSFORMATION_HANDLE Input Transformation handle.
defaultUpdateStrategy INFA_CT_DefaultUpdateStrategy Input Specifies the row strategy you
want the PowerCenter Server to
use for the Custom
transformation.
- eDUS_PASSTHROUGH. Flags
the row for passthrough.
- eDUS_INSERT. Flags rows for
insert.
- eDUS_UPDATE. Flags rows
for update.
- eDUS_DELETE. Flags rows
for delete.
The return value datatype is INFA_STATUS. Use INFA_SUCCESS and INFA_FAILURE for
the return value.
90 Chapter 3: Custom Transformation Functions
Array-Based API Functions
The array-based functions are API functions you use when you change the data access mode
to array-based. For more information about changing the data access mode, see “Set Data
Access Mode Function” on page 66.
Informatica provides the following groups of array-based API functions:
♦ Maximum number of rows. See “Maximum Number of Rows Functions” on page 91.
♦ Number of rows. See “Number of Rows Functions” on page 92.
♦ Is row valid. See “Is Row Valid Function” on page 93.
♦ Data handling (array-based mode). See “Data Handling Functions (Array-Based Mode)”
on page 93.
♦ Row strategy. See “Row Strategy Functions (Array-Based Mode)” on page 96.
♦ Set input error row. See “Set Input Error Row Functions” on page 97.
Maximum Number of Rows Functions
By default, the PowerCenter Server allows a maximum number of rows in an input block and
an output block. However, you can change the maximum number of rows allowed in an
output block.
Use the INFA_CTAGetInputRowMax() and INFA_CTAGetOutputRowMax() functions to
determine the maximum number of rows in input and output blocks. You can use the values
these functions return to determine the buffer size if the procedure needs a buffer.
You can set the maximum number of rows in the output block using the
INFA_CTASetOutputRowMax() function. You might use this function if you want the
procedure to use a larger or smaller buffer.
You can only call these functions in an initialization function.
PowerCenter provides the following functions to determine and set the maximum number of
rows in blocks:
♦ INFA_CTAGetInputRowMax(). Use this function to determine the maximum number of
rows allowed in an input block.
Use the following syntax:
IINT32 INFA_CTAGetInputRowMax( INFA_CT_INPUTGROUP_HANDLE inputgroup );
Input/
Argument Datatype Description
Output
inputgroup INFA_CT_INPUTGROUP_HANDLE Input Input group handle.
♦ INFA_CTAGetOutputRowMax(). Use this function to determine the maximum number
of rows allowed in an output block.
Array-Based API Functions 91
Use the following syntax:
IINT32 INFA_CTAGetOutputRowMax( INFA_CT_OUTPUTGROUP_HANDLE outputgroup );
Input/
Argument Datatype Description
Output
outputgroup INFA_CT_OUTPUTGROUP_HANDLE Input Output group handle.
♦ INFA_CTASetOutputRowMax(). Use this function to set the maximum number of rows
allowed in an output block.
Use the following syntax:
INFA_STATUS INFA_CTASetOutputRowMax( INFA_CT_OUTPUTGROUP_HANDLE
outputgroup, INFA_INT32 nRowMax );
Input/
Argument Datatype Description
Output
outputgroup INFA_CT_OUTPUTGROUP_HANDLE Input Output group handle.
nRowMax INFA_INT32 Input The maximum number of rows you
want to allow in an output block.
You must enter a positive number. The
function returns a fatal error when you
use a non-positive number, including
zero.
Number of Rows Functions
Use the number of rows functions to determine the number of rows in an input block, or to
set the number of rows in an output block for the specified input or output group.
PowerCenter provides the following number of rows functions:
♦ INFA_CTAGetNumRows(). Allows you to determine the number of rows in an input
block.
Use the following syntax:
INFA_INT32 INFA_CTAGetNumRows( INFA_CT_INPUTGROUP_HANDLE inputgroup );
Input/
Argument Datatype Description
Output
inputgroup INFA_CT_INPUTGROUP_HANDLE Input Input group handle.
♦ INFA_CTASetNumRows(). Allows you to set the number of rows in an output block. Call
this function before you call the output notification function.
92 Chapter 3: Custom Transformation Functions
Use the following syntax:
void INFA_CTASetNumRows( INFA_CT_OUTPUTGROUP_HANDLE outputgroup,
INFA_INT32 nRows );
Input/
Argument Datatype Description
Output
outputgroup INFA_CT_OUTPUTGROUP_HANDLE Input Output port handle.
nRows INFA_INT32 Input The number of rows you want to
define in the output block. You must
enter a positive number. The
PowerCenter Server fails the output
notification function when specify a
non-positive number.
Is Row Valid Function
Some rows in a block may be dropped, filter, or error rows. Use the INFA_CTAIsRowValid()
function to determine if a row in a block is valid. This function returns INFA_TRUE when a
row is valid.
Use the following syntax:
INFA_Boolean INFA_CTAIsRowValid( INFA_CT_INPUTGROUP_HANDLE inputgroup,
INFA_INT32 iRow);
Input/
Argument Datatype Description
Output
inputgroup INFA_CT_INPUTGROUP_HANDLE Input Input group handle.
iRow INFA_INT32 Input The index number of the row in the block.
The index is zero-based.
You must verify the procedure only passes
an index number that exists in the data
block. If you pass an invalid value, the
PowerCenter Server shuts down
unexpectedly.
Data Handling Functions (Array-Based Mode)
When the PowerCenter Server calls the p_<proc_name>_inputRowNotification() function, it
notifies the procedure that the procedure can access a row or block of data. However, to get
data from the input port, modify it, and set data in the output port in array-based mode, you
must use the array-based data handling functions in the input row notification function.
Include the INFA_CTAGetData<datatype>() function to get the data from the input port
and INFA_CTASetData() function to set the data in the output port. Include the
INFA_CTAGetIndicator() function if you want the procedure to verify before you get the
data if the port has a null value or an empty string.
Array-Based API Functions 93
PowerCenter provides the following data handling functions for the array-based data access
mode:
♦ INFA_CTAGetData<datatype>(). For more information, see “Get Data Functions (Array-
Based Mode)” on page 94.
♦ INFA_CTAGetIndicator(). For more information, see “Get Indicator Function (Array-
Based Mode)” on page 95.
♦ INFA_CTASetData(). For more information, see “Set Data Function (Array-Based
Mode)” on page 95.
Get Data Functions (Array-Based Mode)
Use the INFA_CTAGetData<datatype>() functions to retrieve data for the port the function
specifies. You must modify the function name depending on the datatype of the port you
want the procedure to access. The PowerCenter Server passes the length of the data in the
array-based get data functions.
Table 3-10 lists the INFA_CTGetData<datatype>() function syntax and the datatype of the
return value:
Table 3-10. Get Data Functions (Array-Based Mode)
Return Value
Syntax
Datatype
void* INFA_CTAGetDataVoid( INFA_CT_INPUTPORT_HANDLE Data void pointer to
inputport, INFA_INT32 iRow, INFA_UINT32* pLength); the return value
char* INFA_CTAGetDataStringM( INFA_CT_INPUTPORT_HANDLE String (MBCS)
inputport, INFA_INT32 iRow, INFA_UINT32* pLength);
IUNICHAR* INFA_CTAGetDataStringU( INFA_CT_INPUTPORT_HANDLE String (Unicode)
inputport, INFA_INT32 iRow, INFA_UINT32* pLength);
INFA_INT32 INFA_CTAGetDataINT32( INFA_CT_INPUTPORT_HANDLE Integer
inputport, INFA_INT32 iRow);
double INFA_CTAGetDataDouble( INFA_CT_INPUTPORT_HANDLE Double
inputport, INFA_INT32 iRow);
INFA_CT_RAWDATETIME INFA_CTAGetDataRawDate( Raw date
INFA_CT_INPUTPORT_HANDLE inputport, INFA_INT32 iRow);
INFA_CT_DATETIME INFA_CTAGetDataDateTime( Datetime
INFA_CT_INPUTPORT_HANDLE inputport, INFA_INT32 iRow);
INFA_CT_RAWDEC18 INFA_CTAGetDataRawDec18( Decimal BLOB
INFA_CT_INPUTPORT_HANDLE inputport, INFA_INT32 iRow); (precision 18)
INFA_CT_RAWDEC28 INFA_CTAGetDataRawDec28( Decimal BLOB
INFA_CT_INPUTPORT_HANDLE inputport, INFA_INT32 iRow); (precision 28)
94 Chapter 3: Custom Transformation Functions
Get Indicator Function (Array-Based Mode)
Use the get indicator function when you want the procedure to verify if the input port has a
null value.
Use the following syntax:
INFA_INDICATOR INFA_CTAGetIndicator( INFA_CT_INPUTPORT_HANDLE inputport,
INFA_INT32 iRow );
Input/
Argument Datatype Description
Output
inputport INFA_CT_INPUTPORT_HANDLE Input Input port handle.
iRow INFA_INT32 Input The index number of the row in the block.
The index is zero-based.
You must verify the procedure only
passes an index number that exists in the
data block. If you pass an invalid value,
the PowerCenter Server shuts down
unexpectedly.
The return value datatype is INFA_INDICATOR. Use the following values for
INFA_INDICATOR:
♦ INFA_DATA_VALID. Indicates the data is valid.
♦ INFA_NULL_DATA. Indicates a null value.
♦ INFA_DATA_TRUNCATED. Indicates the data has been truncated.
Set Data Function (Array-Based Mode)
Use the set data function when you want the procedure to pass a value to an output port. You
can set the data, the length of the data, if applicable, and the indicator for the output port you
specify. You do not use separate functions to set the length or indicator for the output port.
Use the following syntax:
void INFA_CTASetData( INFA_CT_OUTPUTPORT_HANDLE outputport, INFA_INT32
iRow, void* pData, INFA_UINT32 nLength, INFA_INDICATOR indicator);
Input/
Argument Datatype Description
Output
outputport INFA_CT_OUTPUTPORT_HANDLE Input Output port handle.
iRow INFA_INT32 Input The index number of the row in the block. The
index is zero-based.
You must verify the procedure only passes an
index number that exists in the data block. If you
pass an invalid value, the PowerCenter Server
shuts down unexpectedly.
pData void* Input The pointer to the data.
Array-Based API Functions 95
Input/
Argument Datatype Description
Output
nLength INFA_UINT32 Input The length of the port. Use for string and binary
ports only.
You must verify the function passes the exact
length of the data. If the function passes a
different length, the output notification function
returns failure for this port.
Note: Verify the length you set for string and
binary ports is not greater than the precision for
the port. If you set the length greater than the
port precision, you get unexpected results. For
example, the session may fail.
indicator INFA_INDICATOR Input The indicator value for the output port. Use one
of the following values:
- INFA_DATA_VALID. Indicates the data is valid.
- INFA_NULL_DATA. Indicates a null value.
- INFA_DATA_TRUNCATED. Indicates the data
has been truncated.
Row Strategy Functions (Array-Based Mode)
The array-based row strategy functions allow you to access and configure the update strategy
for each row in a block.
PowerCenter provides the following row strategy functions:
♦ INFA_CTAGetRowStrategy(). Allows the procedure to get the update strategy for a row
in a block.
Use the following syntax:
INFA_CT_UPDATESTRATEGY INFA_CTAGetRowStrategy( INFA_CT_INPUTGROUP_HANDLE
inputgroup, INFA_INT32 iRow);
Input/
Argument Datatype Description
Output
inputgroup INFA_CT_INPUTGROUP_HANDLE Input Input group handle.
iRow INFA_INT32 Input The index number of the row in the block.
The index is zero-based.
You must verify the procedure only passes
an index number that exists in the data
block. If you pass an invalid value, the
PowerCenter Server shuts down
unexpectedly.
96 Chapter 3: Custom Transformation Functions
♦ INFA_CTASetRowStrategy(). Sets the update strategy for a row in a block.
Use the following syntax:
void INFA_CTASetRowStrategy( INFA_CT_OUTPUTGROUP_HANDLE outputgroup,
INFA_INT32 iRow, INFA_CT_UPDATESTRATEGY updateStrategy );
Input/
Argument Datatype Description
Output
outputgroup INFA_CT_OUTPUTGROUP_HANDLE Input Output group handle.
iRow INFA_INT32 Input The index number of the row in the
block. The index is zero-based.
You must verify the procedure only
passes an index number that exists in
the data block. If you pass an invalid
value, the PowerCenter Server shuts
down unexpectedly.
updateStrategy INFA_CT_UPDATESTRATEGY Input The update strategy for the port. Use
one of the following values:
- eUS_INSERT = 0
- eUS_UPDATE = 1
- eUS_DELETE = 2
- eUS_REJECT = 3
Set Input Error Row Functions
When you use array-based access mode, you cannot return INFA_ROWERROR in the input
row notification function. Instead, use the set input error row functions to notify the
PowerCenter Server that a particular input row has an error.
PowerCenter provides the following set input row functions in array-based mode:
♦ INFA_CTASetInputErrorRowM(). Allows you to notify the PowerCenter Server that a
row in the input block has an error and to output an MBCS error message to the session
log.
Use the following syntax:
INFA_STATUS INFA_CTASetInputErrorRowM( INFA_CT_INPUTGROUP_HANDLE
inputGroup, INFA_INT32 iRow, size_t nErrors, INFA_MBCSCHAR* sErrMsg );
Input/
Argument Datatype Description
Output
inputGroup INFA_CT_INPUTGROUP_HANDLE Input Input group handle.
iRow INFA_INT32 Input The index number of the row in the
block. The index is zero-based.
You must verify the procedure only
passes an index number that exists in
the data block. If you pass an invalid
value, the PowerCenter Server shuts
down unexpectedly.
Array-Based API Functions 97
Input/
Argument Datatype Description
Output
nErrors size_t Input Use this parameter to specify the number
of errors this input row has caused.
sErrMsg INFA_MBCSCHAR* Input The MBCS string containing the error
message you want the function to output.
You must enter a null-terminated string.
This parameter is optional. When you
include this argument, the PowerCenter
Server prints the message in the session
log, even when you enable row error
logging.
♦ INFA_CTASetInputErrorRowU(). Allows you to notify the PowerCenter Server that a
row in the input block has an error and to output a Unicode error message to the session
log.
Use the following syntax:
INFA_STATUS INFA_CTASetInputErrorRowU( INFA_CT_INPUTGROUP_HANDLE
inputGroup, INFA_INT32 iRow, size_t nErrors, INFA_UNICHAR* sErrMsg );
Input/
Argument Datatype Description
Output
inputGroup INFA_CT_INPUTGROUP_HANDLE Input Input group handle.
iRow INFA_INT32 Input The index number of the row in the block.
The index is zero-based.
You must verify the procedure only
passes an index number that exists in the
data block. If you pass an invalid value,
the PowerCenter Server shuts down
unexpectedly.
nErrors size_t Input Use this parameter to specify the number
of errors this output row has caused.
sErrMsg INFA_UNICHAR* Input The Unicode string containing the error
message you want the function to output.
You must enter a null-terminated string.
This parameter is optional. When you
include this argument, the PowerCenter
Server prints the message in the session
log, even when you enable row error
logging.
98 Chapter 3: Custom Transformation Functions
Chapter 4
Expression
Transformation
This chapter covers the following topics:
♦ Overview, 100
♦ Creating an Expression Transformation, 101
99
Overview
Transformation type:
Passive
Connected
You can use the Expression transformation to calculate values in a single row before you write
to the target. For example, you might need to adjust employee salaries, concatenate first and
last names, or convert strings to numbers. You can use the Expression transformation to
perform any non-aggregate calculations. You can also use the Expression transformation to
test conditional statements before you output the results to target tables or other
transformations.
Note: To perform calculations involving multiple rows, such as sums or averages, use the
Aggregator transformation. Unlike the Expression transformation, the Aggregator allows you
to group and sort data. For details, see “Aggregator Transformation” on page 1.
Calculating Values
To use the Expression transformation to calculate values for a single row, you must include the
following ports:
♦ Input or input/output ports for each value used in the calculation. For example, when
calculating the total price for an order, determined by multiplying the unit price by the
quantity ordered, the input or input/output ports. One port provides the unit price and
the other provides the quantity ordered.
♦ Output port for the expression. You enter the expression as a configuration option for the
output port. The return value for the output port needs to match the return value of the
expression. For information on entering expressions, see “Transformations” in the Designer
Guide. Expressions use the transformation language, which includes SQL-like functions,
to perform calculations.
Adding Multiple Calculations
You can enter multiple expressions in a single Expression transformation. As long as you enter
only one expression for each output port, you can create any number of output ports in the
transformation. In this way, you can use one Expression transformation rather than creating
separate transformations for each calculation that requires the same set of data.
For example, you might want to calculate several types of withholding taxes from each
employee paycheck, such as local and federal income tax, Social Security and Medicare. Since
all of these calculations require the employee salary, the withholding category, and/or the
corresponding tax rate, you can create one Expression transformation with the salary and
withholding category as input/output ports and a separate output port for each necessary
calculation.
100 Chapter 4: Expression Transformation
Creating an Expression Transformation
Use the following procedure to create an Expression transformation.
To create an Expression transformation:
1. In the Mapping Designer, choose Transformation-Create. Select the Expression
transformation. Enter a name for it (the convention is EXP_TransformationName) and
click OK.
2. Create the input ports.
If you have the input transformation available, you can select Link Columns from the
Layout menu and then click and drag each port used in the calculation into the
Expression transformation. With this method, the Designer copies the port into the new
transformation and creates a connection between the two ports. Or, you can open the
transformation and create each port manually.
Note: If you want to make this transformation reusable, you must create each port
manually within the transformation.
3. Repeat the previous step for each input port you want to add to the expression.
4. Create the output ports (O) you need, making sure to assign a port datatype that matches
the expression return value. The naming convention for output ports is
OUT_PORTNAME.
5. Click the small button that appears in the Expression section of the dialog box and enter
the expression in the Expression Editor.
To prevent typographic errors, where possible, use the listed port names and functions.
If you select a port name that is not connected to the transformation, the Designer copies
the port into the new transformation and creates a connection between the two ports.
Port names used as part of an expression in an Expression transformation follow stricter
rules than port names in other types of transformations:
♦ A port name must begin with a single- or double-byte letter or single- or double-byte
underscore (_).
♦ It can contain any of the following single- or double-byte characters: a letter, number,
underscore (_), $, #, or @.
6. Check the expression syntax by clicking Validate.
If necessary, make corrections to the expression and check the syntax again. Then save the
expression and exit the Expression Editor.
7. Connect the output ports to the next transformation or target.
8. Select a tracing level on the Properties tab to determine the amount of transaction detail
reported in the session log file.
9. Choose Repository-Save.
Creating an Expression Transformation 101
102 Chapter 4: Expression Transformation
Chapter 5
External Procedure
Transformation
This chapter covers the following topics:
♦ Overview, 104
♦ Developing COM Procedures, 107
♦ Developing Informatica External Procedures, 117
♦ Distributing External Procedures, 127
♦ Development Notes, 129
♦ Server Variables Support in Initialization Properties, 138
♦ External Procedure Interfaces, 139
103
Overview
Transformation type:
Passive
Connected/Unconnected
External Procedure transformations operate in conjunction with procedures you create
outside of the Designer interface to extend PowerCenter functionality.
Although the standard transformations provide you with a wide range of options, there are
occasions when you might want to extend the functionality provided with PowerCenter. For
example, the range of standard transformations, such as Expression and Filter
transformations, may not provide the exact functionality you need. If you are an experienced
programmer, you may want to develop complex functions within a dynamic link library
(DLL) or UNIX shared library, instead of creating the necessary Expression transformations
in a mapping.
To obtain this kind of extensibility, you can use the Transformation Exchange (TX) dynamic
invocation interface built into PowerCenter. Using TX, you can create an Informatica
External Procedure transformation and bind it to an external procedure that you have
developed. You can bind External Procedure transformations to two kinds of external
procedures:
♦ COM external procedures (available on Windows only)
♦ Informatica external procedures (available on Windows, AIX, HP-UX, Linux, and Solaris)
To use TX, you must be an experienced C, C++, or Visual Basic programmer.
You can use multi-threaded code in external procedures.
Note: You can visit the Informatica Webzine at http://my.informatica.com for examples using
External Procedure transformations.
Code Page Compatibility
When the PowerCenter Server runs in ASCII mode, the external procedure can process data
in 7-bit ASCII.
When the PowerCenter Server runs in Unicode mode, the external procedure can process data
that is two-way compatible with the PowerCenter Server code page. For information about
accessing the PowerCenter Server code page, see “Code Page Access Functions” on page 143.
Configure the PowerCenter Server to run in Unicode mode if the external procedure DLL or
shared library contains multibyte characters. External procedures must use the same code page
as the PowerCenter Server to interpret input strings from the PowerCenter Server and to
create output strings that contain multibyte characters.
Configure the PowerCenter Server to run in either ASCII or Unicode mode if the external
procedure DLL or shared library contains ASCII characters only.
104 Chapter 5: External Procedure Transformation
External Procedures and External Procedure Transformations
There are two components to TX: external procedures and External Procedure transformations.
As its name implies, an external procedure exists separately from the PowerCenter Server. It
consists of C, C++, or Visual Basic code written by a user to define a transformation. This
code is compiled and linked into a DLL or shared library, which is loaded by the PowerCenter
Server at runtime. An external procedure is “bound” to an External Procedure transformation.
An External Procedure transformation is created in the Designer. It is an object that resides in
the Informatica repository and serves several purposes:
1. It contains the metadata describing the following external procedure. It is through this
metadata that the PowerCenter Server knows the “signature” (number and types of
parameters, type of return value, if any) of the external procedure.
2. It allows an external procedure to be referenced in a mapping. By adding an instance of
an External Procedure transformation to a mapping, you call the external procedure
bound to that transformation.
Note: Just as with a Stored Procedure transformation, you can use an External Procedure
transformation in a mapping in two ways. You can connect its ports to the ports of other
transformations in a mapping, or you can use it in an expression in an Expression
transformation.
3. When you develop Informatica external procedures, the External Procedure
transformation provides the information required to generate Informatica external
procedure stubs.
External Procedure Transformation Properties
Create reusable External Procedure transformations in the Transformation Developer, and
add instances of the transformation to mappings. You cannot create External Procedure
transformations in the Mapping Designer or Mapplet Designer.
External Procedure transformations return one or no output rows per input row.
On the Properties tab of the External Procedure transformation, only enter ASCII characters
in the Module/Programmatic Identifier and Procedure Name fields. You cannot enter
multibyte characters in these fields. On the Ports tab of the External Procedure
transformation, only enter ASCII characters for the port names. You cannot enter multibyte
characters for External Procedure transformation port names.
Pipeline Partitioning
If you purchase the Partitioning option with PowerCenter, you can increase the number of
partitions in a pipeline to improve session performance. Increasing the number of partitions
allows the PowerCenter Server to create multiple connections to sources and process
partitions of source data concurrently.
Overview 105
When you create a session, the Workflow Manager validates each pipeline in the mapping for
partitioning. You can specify multiple partitions in a pipeline if the PowerCenter Server can
maintain data consistency when it processes the partitioned data.
When you use an External Procedure transformation, you must specify whether or not you
can create multiple partitions in the pipeline. For External Procedure transformations, the Is
Partitionable check box on the Properties tab allows you to do this. For more information
about pipeline partitioning, see “Pipeline Partitioning” in the Workflow Administration Guide.
COM Versus Informatica External Procedures
Table 5-1 describes the differences between COM and Informatica external procedures:
Table 5-1. Differences Between COM and Informatica External Procedures
COM Informatica
Technology Uses COM technology Uses Informatica proprietary technology
Operating System Runs on Windows only Runs on all platforms supported for the PowerCenter
Server: Windows, AIX, HP, Linux, Solaris
Language C, C++, VC++, VB, Perl, VJ++ Only C++
The BankSoft Example
The following sections use an example called BankSoft to illustrate how to develop COM and
Informatica procedures. The BankSoft example uses a financial function, FV, to illustrate how
to develop and call an external procedure. The FV procedure calculates the future value of an
investment based on regular payments and a constant interest rate.
106 Chapter 5: External Procedure Transformation
Developing COM Procedures
You can develop COM external procedures using Microsoft Visual C++ or Visual Basic. The
following sections describe how to create COM external procedures using Visual C++ and
how to create COM external procedures using Visual Basic.
Steps for Creating a COM Procedure
To create a COM external procedure, complete the following steps:
1. Using Microsoft Visual C++ or Visual Basic, create a project.
2. Define a class with an IDispatch interface.
3. Add a method to the interface. This method is the external procedure that will be
invoked from inside the PowerCenter Server.
4. Compile and link the class into a dynamic link library.
5. Register the class in the local Windows registry.
6. Import the COM procedure in the Transformation Developer.
7. Create a mapping with the COM procedure.
8. Create a session using the mapping.
COM External Procedure Server Type
The PowerCenter Server only supports in-process COM servers (that is, COM servers with
Server Type: Dynamic Link Library). This is done to enhance performance. It is more efficient
when processing large amounts of data to process the data in the same process, instead of
forwarding it to a separate process on the same machine or a remote machine.
Using Visual C++ to Develop COM Procedures
C++ developers can use Visual C++ version 5.0 or later to develop COM procedures. The first
task is to create a project.
Step 1. Create an ATL COM AppWizard Project
1. Launch Visual C++ and choose File-New.
2. In the dialog box that appears, select the Projects tab.
3. Enter the project name and location.
In the BankSoft example, you enter COM_VC_Banksoft as the project name, and
c:\COM_VC_Banksoft as the directory.
4. Select the ATL COM AppWizard option in the projects list box and click OK.
Developing COM Procedures 107
A wizard used to create COM projects in Visual C++ appears.
5. Set the Server Type to Dynamic Link Library, check the Support MFC option, and click
Finish.
The final page of the wizard appears.
6. Click OK to return to Visual C++.
7. Add a class to the new project.
8. On the next page of the wizard, click the OK button. The Developer Studio creates the
basic project files.
Step 2. Add an ATL Object to Your Project
1. In the Workspace window, select the Class View tab, right-click the tree item
COM_VC_BankSoft.BSoftFin classes, and choose New ATL Object from the local menu
that appears.
2. Highlight the Objects item in the left list box and select Simple Object from the list of
object types.
3. Click Next.
4. In the Short Name field, enter a short name for the class you want to create.
In the BankSoft example, use the name BSoftFin, since you are developing a financial
function for the fictional company BankSoft. As you type into the Short Name field, the
wizard fills in suggested names in the other fields.
5. Enter the programmatic identifier for the class.
In the BankSoft example, change the ProgID (programmatic identifier) field to
COM_VC_BankSoft.BSoftFin.
A programmatic identifier, or ProgID, is the human-readable name for a class. Internally,
classes are identified by numeric CLSID's. For example:
{33B17632-1D9F-11D1-8790-0000C044ACF9}
The standard format of a ProgID is Project.Class[.Version]. In the Designer, you refer to
COM classes through ProgIDs.
6. Select the Attributes tab and set the threading model to Free, the interface to Dual, and
the aggregation setting to No.
7. Click OK.
Now that you have a basic class definition, you can add a method to it.
Step 3. Add the Required Methods to the Class
1. Return to the Classes View tab of the Workspace Window.
2. Expand the tree view.
108 Chapter 5: External Procedure Transformation
For the BankSoft example, you expand COM_VC_BankSoft.
3. Right-click the newly-added class.
In the BankSoft example, you right-click the IBSoftFin tree item.
4. Click the Add Method menu item and enter the name of the method.
In the BankSoft example, you enter FV.
5. In the Parameters field, enter the signature of the method.
For FV, enter the following:
[in] double Rate,
[in] long nPeriods,
[in] double Payment,
[in] double PresentValue,
[in] long PaymentType,
[out, retval] double* FV
This signature is expressed in terms of the Microsoft Interface Description Language
(MIDL). For a complete description of MIDL, see the MIDL language reference. Note
that:
♦ [in] indicates that the parameter is an input parameter.
♦ [out] indicates that the parameter is an output parameter.
♦ [out, retval] indicates that the parameter is the return value of the method.
Also, note that all [out] parameters are passed by reference. In the BankSoft example, the
parameter FV is a double.
6. Click OK.
The Developer Studio adds to the project a stub for the method you added.
Step 4. Fill Out the Method Stub with an Implementation
1. In the BankSoft example, return to the Class View tab of the Workspace window and
expand the COM_VC_BankSoft classes item.
2. Expand the CBSoftFin item.
3. Expand the IBSoftFin item under the above item.
4. Right-click the FV item and choose Go to Definition.
5. Position your cursor in the edit window on the line after the TODO comment and add
the following code:
double v = pow((1 + Rate), nPeriods);
*FV = -(
(PresentValue * v) +
(Payment * (1 + (Rate * PaymentType))) * ((v - 1) / Rate)
);
Developing COM Procedures 109
Since you refer to the pow function, you have to add the following preprocessor
statement after all other include statements at the beginning of the file:
#include <math.h>
The final step is to build the DLL. When you build it, you automatically register the
COM procedure with the Windows registry.
Step 5. Build the Project
1. Pull down the Build menu.
2. Select Rebuild All.
As Developer Studio builds the project, it generates the following output:
------------Configuration: COM_VC_BankSoft - Win32 Debug--------------
Performing MIDL step
Microsoft (R) MIDL Compiler Version 3.01.75
Copyright (c) Microsoft Corp 1991-1997. All rights reserved.
Processing .\COM_VC_BankSoft.idl
COM_VC_BankSoft.idl
Processing C:\msdev\VC\INCLUDE\oaidl.idl
oaidl.idl
Processing C:\msdev\VC\INCLUDE\objidl.idl
objidl.idl
Processing C:\msdev\VC\INCLUDE\unknwn.idl
unknwn.idl
Processing C:\msdev\VC\INCLUDE\wtypes.idl
wtypes.idl
Processing C:\msdev\VC\INCLUDE\ocidl.idl
ocidl.idl
Processing C:\msdev\VC\INCLUDE\oleidl.idl
oleidl.idl
Compiling resources...
Compiling...
StdAfx.cpp
Compiling...
COM_VC_BankSoft.cpp
BSoftFin.cpp
Generating Code...
Linking...
Creating library Debug/COM_VC_BankSoft.lib and object Debug/
COM_VC_BankSoft.exp
Registering ActiveX Control...
RegSvr32: DllRegisterServer in .\Debug\COM_VC_BankSoft.dll succeeded.
COM_VC_BankSoft.dll - 0 error(s), 0 warning(s)
Notice that Visual C++ compiles the files in the project, links them into a dynamic link
library (DLL) called COM_VC_BankSoft.DLL, and registers the COM (ActiveX) class
COM_VC_BankSoft.BSoftFin in the local registry.
Once the component is registered, it is accessible to the PowerCenter Server running on that
host.
110 Chapter 5: External Procedure Transformation
For more information about how to package COM classes for distribution to other
PowerCenter Servers, see “Distributing External Procedures” on page 127.
For more information about how to use COM external procedures to call functions in a
preexisting library of C or C++ functions, see “Wrapper Classes for Pre-Existing C/C++
Libraries or VB Functions” on page 131.
For more information about how to use a class factory to initialize COM objects, see
“Initializing COM and Informatica Modules” on page 133.
Step 6. Register a COM Procedure with the Repository
1. Open the Transformation Developer.
2. Choose Transformation-Import External Procedure.
The Import External COM Method dialog box appears.
3. Click the Browse button.
Locate the COM procedure.
4. Select the COM DLL you created and click OK.
In the Banksoft example, select COM_VC_Banksoft.DLL.
5. Under Select Method tree view, expand the class node (in this example, BSoftFin).
6. Expand Methods.
7. Select the method you want (in this example, FV) and press OK.
The Designer creates an External Procedure transformation.
8. Open the External Procedure transformation, and select the Properties tab.
Developing COM Procedures 111
The transformation properties display:
Enter ASCII characters in the Module/Programmatic Identifier and Procedure Name
fields.
9. Click the Ports tab.
Enter ASCII characters in the Port Name fields. For more information about mapping
Visual C++ and Visual Basic datatypes to COM datatypes, see “COM Datatypes” on
page 129.
10. Click OK, then choose Repository-Save.
The repository now contains the reusable transformation, so you can add instances of this
transformation to mappings.
112 Chapter 5: External Procedure Transformation
Step 7. Create a Source and a Target for a Mapping
Use the following SQL statements to create a source table and to populate this table with
sample data:
create table FVInputs(
Rate float,
nPeriods int,
Payment float,
PresentValue float,
PaymentType int
)
insert into FVInputs values (.005,10,-200.00,-500.00,1)
insert into FVInputs values (.01,12,-1000.00,0.00,0)
insert into FVInputs values (.11/12,35,-2000.00,0.00,1)
insert into FVInputs values (.005,12,-100.00,-1000.00,1)
Use the following SQL statement to create a target table:
create table FVOutputs(
FVin_ext_proc float,
)
Use the Source Analyzer and the Warehouse Designer to import FVInputs and FVOutputs
into the same folder as the one in which you created the COM_BSFV transformation.
Step 8. Create a Mapping to Test the External Procedure Transformation
Now create a mapping to test the External Procedure transformation:
1. In the Mapping Designer, create a new mapping named Test_BSFV.
2. Drag the source table FVInputs into the mapping.
3. Drag the target table FVOutputs into the mapping.
4. Drag the transformation COM_BSFV into the mapping.
5. Connect the Source Qualifier transformation ports to the External Procedure
transformation ports as appropriate.
6. Connect the FV port in the External Procedure transformation to the FVIn_ext_proc
target column.
Developing COM Procedures 113
7. Validate and save the mapping.
Step 9. Start the Informatica Service
Start the Informatica service. Note that the service must be started on the same host as the
one on which the COM component was registered.
Step 10. Run a Workflow to Test the Mapping
When the PowerCenter Server runs the session in a workflow, it performs the following
functions:
♦ Uses the COM runtime facilities to load the DLL and create an instance of your class.
♦ Uses the COM IDispatch interface to call the external procedure you defined once for
every row that passes through the mapping.
Note: Multiple classes, each with multiple methods, can be defined within a single project.
Each of these methods can be invoked as an external procedure.
To run a workflow to test the mapping:
1. In the Workflow Manager, create the session s_Test_BSFV from the Test_BSFV
mapping.
2. Create a workflow that contains the session s_Test_BSFV.
3. Run the workflow. The PowerCenter Server searches the registry for the entry for the
COM_VC_BankSoft.BSoftFin class. This entry has information that allows the
PowerCenter Server to determine the location of the DLL that contains that class. The
PowerCenter Server loads the DLL, creates an instance of the class, and invokes the FV
function for every row in the source table.
When the workflow finishes, the FVOutputs table should contain the following results:
FVIn_ext_proc
2581.403374
12682.503013
82846.246372
2301.401830
Developing COM Procedures with Visual Basic
Microsoft Visual Basic offers a different development environment for creating COM
procedures. While the Basic language has different syntax and conventions, the development
procedure has the same broad outlines as developing COM procedures in Visual C++.
Step 1. Create a Visual Basic Project with a Single Class
1. Launch Visual Basic and Choose File-New Project.
114 Chapter 5: External Procedure Transformation
2. In the dialog box that appears, select ActiveX DLL as the project type and click OK.
Visual Basic creates a new project named Project1.
If the Project window does not display, type Ctrl+R, or choose View-Project Explorer.
If the Properties window does not display, press F4, or choose View-Properties.
3. In the Project Explorer window for the new project, right-click the project and choose
Project1 Properties from the menu that appears.
4. Enter the name of the new project.
In the Project window, select Project1 and change the name in the Properties window to
COM_VB_BankSoft.
Step 2. Change the Names of the Project and Class
1. Inside the Project Explorer, select the “Project – Project1” item, which should be the root
item in the tree control. The project properties display in the Properties Window.
2. Select the Alphabetic tab in the Properties Window and change the Name property to
COM_VB_BankSoft. This renames the root item in the Project Explorer to
COM_VB_BankSoft (COM_VB_BankSoft).
3. Expand the COM_VB_BankSoft (COM_VB_BankSoft) item in the Project Explorer.
4. Expand the Class Modules item.
5. Select the Class1 (Class1) item. The properties of the class display in the Properties
Window.
6. Select the Alphabetic tab in the Properties Window and change the Name property to
BSoftFin.
By changing the name of the project and class, you specify that the programmatic identifier
for the class you create is “COM_VB_BankSoft.BSoftFin.” Use this ProgID to refer to this
class inside the Designer.
Step 3. Add a Method to the Class
Place the cursor inside the Code window and enter the following text:
Public Function FV( _
Rate As Double, _
nPeriods As Long, _
Payment As Double, _
PresentValue As Double, _
PaymentType As Long _
) As Double
Dim v As Double
v = (1 + Rate) ^ nPeriods
FV = -( _
(PresentValue * v) + _
Developing COM Procedures 115
(Payment * (1 + (Rate * PaymentType))) * ((v - 1) / Rate) _
)
End Function
This Visual Basic FV function, of course, performs exactly the same operation as the C++ FV
function in “Developing COM Procedures with Visual Basic” on page 114.
Step 4. Build the Project
To build the project:
1. From the File menu, select the Make COM_VB_BankSoft.DLL. A dialog box prompts
you for the file location.
2. Enter the file location and click OK.
Visual Basic compiles your source code and creates the COM_VB_BankSoft.DLL in the
location you specified. It also registers the class COM_VB_BankSoft.BSoftFin in the local
registry.
Once the component is registered, it is accessible to the PowerCenter Server running on that
host.
For more information about how to package Visual Basic COM classes for distribution to
other machines hosting the PowerCenter Server, see “Distributing External Procedures” on
page 127.
For more information about how to use Visual Basic external procedures to call preexisting
Visual Basic functions, see “Wrapper Classes for Pre-Existing C/C++ Libraries or VB
Functions” on page 131.
To create the procedure, follow steps 6 - 9 of “Using Visual C++ to Develop COM
Procedures” on page 107.
116 Chapter 5: External Procedure Transformation
Developing Informatica External Procedures
You can create external procedures that run on 32-bit or 64-bit PowerCenter Server machines.
To create an Informatica-style external procedure, follow these steps:
1. In the Transformation Developer, create an External Procedure transformation.
The External Procedure transformation defines the signature of the procedure. The
names of the ports, datatypes and port type (input or output) must match the signature
of the external procedure.
2. Generate the template code for the external procedure.
3. When you execute this command, the Designer uses the information from the External
Procedure transformation to create several C++ source code files (and a makefile). One of
these source code files contains a “stub” for the function whose signature you defined in
the transformation.
4. Modify the code to add the procedure logic. Fill out the stub with an implementation
and use your C++ compiler to compile and link the source code files into a dynamic link
library or shared library.
5. When the PowerCenter Server encounters an External Procedure transformation bound
to an Informatica procedure, it loads the DLL or shared library and calls the external
procedure you defined.
6. Build the library and copy it to the PowerCenter Server machine.
7. Create a mapping with the External Procedure transformation.
8. Run the session in a workflow.
We use the BankSoft example to illustrate how to implement this feature.
Step 1. Create the External Procedure Transformation
1. Open the Transformation Developer and create an External Procedure transformation.
2. Open the transformation and enter a name for it.
In the BankSoft example, enter EP_extINF_BSFV.
3. Create a port for each argument passed to the procedure you plan to define.
Be sure that you use the correct datatypes.
Developing Informatica External Procedures 117
To use the FV procedure as an example, you create the following ports. The last port, FV,
captures the return value from the procedure:
4. Select the Properties tab and configure the procedure as an Informatica procedure.
In the BankSoft example, enter the following:
Module/Programmatic
Identifier
Runtime Location
Note on Module/Programmatic Identifier:
♦ The module name is the base name of the dynamic link library (on Windows) or the
shared object (on UNIX) that contains your external procedures. The following table
118 Chapter 5: External Procedure Transformation
describes how the module name determines the name of the DLL or shared object on
the various platforms:
Operating System Module Identifier Library File Name
Windows INF_BankSoft INF_BankSoft.DLL
AIX INF_BankSoft libINF_BankSoftshr.a
HPUX INF_BankSoft libINF_BankSoft.sl
Linux INF_BankSoft libINF_BankSoft.so
Solaris INF_BankSoft libINF_BankSoft.so.1
Notes on Runtime Location:
♦ If you set the Runtime Location to $PMExtProcDir, then the PowerCenter Server
looks in the directory specified by the server variable $PMExtProcDir to locate the
library.
♦ If you leave the Runtime Location property blank, the PowerCenter Server uses the
environment variable defined on the server platform to locate the dynamic link library
or shared object. The following table describes the environment variables used to
locate the DLL or shared object on the various platforms:
Operating System Environment Variable
Windows PATH
AIX LIBPATH
HPUX SHLIB_PATH
Linux LD_LIBRARY_PATH
Solaris LD_LIBRARY_PATH
♦ You can hard code a path as the Runtime Location. This is not recommended since the
path is specific to a single machine only.
Note: You must copy all DLLs or shared libraries to the Runtime Location or to the
environment variable defined on the PowerCenter Server machine. The PowerCenter
Server fails to load the external procedure when it cannot locate the DLL, shared library,
or a referenced file.
5. Click OK.
6. Choose Repository-Save.
After you create the External Procedure transformation that calls the procedure, the next step
is to generate the C++ files.
Developing Informatica External Procedures 119
Step 2. Generate the C++ Files
After you create an External Procedure transformation, you generate the code. The Designer
generates file names in lower case since files created on UNIX-mapped drives are always in
lower case. The following rules apply to the generated files:
♦ File names. A prefix ‘tx’ is used for TX module files.
♦ Module class names. The generated code has class declarations for the module that
contains the TX procedures. A prefix Tx is used for TX module classes. For example, if an
External Procedure transformation has a module name Mymod, then the class name is
TxMymod.
To generate the code for an external procedure:
1. Select the transformation and choose Transformation-Generate Code.
2. Select the check box next to the name of the procedure you just created.
In the BankSoft example, select INF_BankSoft.FV.
3. Specify the directory where you want to generate the files, and click Generate.
The Designer creates a subdirectory, INF_BankSoft, in the directory you specified.
Each External Procedure transformation created in the Designer must specify a module
and a procedure name. The Designer generates code in a single directory for all
transformations sharing a common module name. Building the code in one directory
creates a single shared library.
The Designer generates the following files:
♦ tx<moduleName>.h. Defines the external procedure module class. This class is derived
from a base class TINFExternalModule60. No data members are defined for this class
in the generated code. However, you can add new data members and methods here.
♦ tx<moduleName>.cpp. Implements the external procedure module class. You can
expand the InitDerived() method to include initialization of any new data members
you add. The PowerCenter Server calls the derived class InitDerived() method only
when it successfully completes the base class Init() method.
This file defines the signatures of all External Procedure transformations in the module.
Any modification of these signatures leads to inconsistency with the External Procedure
transformations defined in the Designer. Therefore, you should not change the
signatures.
This file also includes a C function CreateExternalModuleObject, which creates an
object of the external procedure module class using the constructor defined in this file.
The PowerCenter Server calls CreateExternalModuleObject instead of directly calling the
constructor.
♦ <procedureName>.cpp. The Designer generates one of these files for each external
procedure in this module. This file contains the code that implements the procedure
logic, such as data cleansing and filtering. For data cleansing, create code to read in
values from the input ports and generate values for output ports. For filtering, create
120 Chapter 5: External Procedure Transformation
code to suppress generation of output rows by returning INF_NO_OUTPUT_ROW
whenever desired.
♦ stdafx.h. Stub file used for building on UNIX systems. The various *.cpp files include
this file. On Windows systems, the Visual Studio generates an stdafx.h file, which
should be used instead of the Designer generated file.
♦ version.cpp. This is a small file that carries the version number of this
implementation. In earlier releases, external procedure implementation was handled
differently. This file allows the PowerCenter Server to determine the version of the
external procedure module.
♦ makefile.aix, makefile.aix64, makefile.hp, makefile.hp64, makefile.linux,
makefile.sol. Make files for UNIX platforms. Use makefile.aix, makefile.hp,
makefile.linux, and makefile.sol for 32-bit platforms. Use makefile.aix64 for 64-bit
AIX platforms and makefile.hp64 for 64-bit HP-UX (Itanium) platforms.
Example 1
In the BankSoft example, the Designer generates the following files:
♦ txinf_banksoft.h. Contains declarations for module class TxINF_BankSoft and external
procedure FV.
♦ txinf_banksoft.cpp. Contains code for module class TxINF_BankSoft.
♦ fv.cpp. Contains code for procedure FV.
♦ version.cpp. Returns TX version.
♦ stdafx.h. Required for compilation on UNIX. On Windows, stdafx.h is generated by
Visual Studio.
♦ readme.txt. Contains general help information.
Example 2
If you create two External Procedure transformations with procedure names ‘Myproc1’ and
‘Myproc2,’ both with the module name Mymod, the Designer generates the following files:
♦ txmymod.h. Contains declarations for module class TxMymod and external procedures
Myproc1 and Myproc2.
♦ txmymod.cpp. Contains code for module class TxMymod.
♦ myproc1.cpp. Contains code for procedure Myproc1.
♦ myproc2.cpp. Contains code for procedure Myproc2.
♦ version.cpp.
♦ stdafx.h.
♦ readme.txt.
Developing Informatica External Procedures 121
Step 3. Fill Out the Method Stub with Implementation
The final step is coding the procedure.
1. Open the <Your_Procedure_Name>.cpp stub file generated for the procedure.
In the BankSoft example, you open fv.cpp to code the TxINF_BankSoft::FV procedure.
2. Enter the C++ code for the procedure.
The following code implements the FV procedure:
INF_RESULT TxINF_BankSoft::FV()
{
// Input port values are mapped to the m_pInParamVector array in
// the InitParams method. Use m_pInParamVector[i].IsValid() to check
// if they are valid. Use m_pInParamVector[i].GetLong or GetDouble,
// etc. to get their value. Generate output data into m_pOutParamVector.
// TODO: Fill in implementation of the FV method here.
ostrstream ss;
char* s;
INF_Boolean bVal;
double v;
TINFParam* Rate = &m_pInParamVector[0];
TINFParam* nPeriods = &m_pInParamVector[1];
TINFParam* Payment = &m_pInParamVector[2];
TINFParam* PresentValue = &m_pInParamVector[3];
TINFParam* PaymentType = &m_pInParamVector[4];
TINFParam* FV = &m_pOutParamVector[0];
bVal =
INF_Boolean(
Rate->IsValid() &&
nPeriods->IsValid() &&
Payment->IsValid() &&
PresentValue->IsValid() &&
PaymentType->IsValid()
);
if (bVal == INF_FALSE)
{
FV->SetIndicator(INF_SQL_DATA_NULL);
return INF_SUCCESS;
}
122 Chapter 5: External Procedure Transformation
v = pow((1 + Rate->GetDouble()), (double)nPeriods->GetLong());
FV->SetDouble(
-(
(PresentValue->GetDouble() * v) +
(Payment->GetDouble() *
(1 + (Rate->GetDouble() * PaymentType->GetLong()))) *
((v - 1) / Rate->GetDouble())
)
);
ss << "The calculated future value is: " << FV->GetDouble() <<ends;
s = ss.str();
(*m_pfnMessageCallback)(E_MSG_TYPE_LOG, 0, s);
(*m_pfnMessageCallback)(E_MSG_TYPE_ERR, 0, s);
delete [] s;
return INF_SUCCESS;
}
The Designer generates the function profile, including the arguments and return value.
You need to enter the actual code within the function, as indicated in the comments.
Since you referenced the POW function and defined an ostrstream variable, you must
also include the preprocessor statements:
On Windows:
#include <math.h>;
#include <strstrea.h>;
On UNIX, the include statements would be the following:
#include <math.h>;
#include <strstream.h>;
3. Save the modified file.
Step 4. Building the Module
On Windows, you can use Visual C++ to compile the DLL.
To build a DLL on Windows:
1. Start Visual C++.
2. Choose File-New.
3. In the New dialog box, click the Projects tab and select the MFC AppWizard (DLL)
option.
Developing Informatica External Procedures 123
4. Enter its location.
In the BankSoft example, you enter c:\pmclient\tx\INF_BankSoft, assuming you
generated files in c:\pmclient\tx.
5. Enter the name of the project.
It must be the same as the module name entered for the External Procedure
transformation. In the BankSoft example, it is INF_BankSoft.
6. Click OK.
Visual C++ now steps you through a wizard that defines all the components of the
project.
7. In the wizard, click MFC Extension DLL (using shared MFC DLL).
8. Click Finish.
The wizard generates several files.
9. Choose Project-Add To Project-Files.
10. Navigate up a directory level. This directory contains the external procedure files you
created. Select all .cpp files.
In the BankSoft example, add the following files:
♦ fv.cpp
♦ txinf_banksoft.cpp
♦ version.cpp
11. Choose Project-Settings.
12. Click the C/C++ tab, and select Preprocessor from the Category field.
13. In the Additional Include Directories field, enter ..; <pmserver install
dir>\extproc\include.
14. Click the Link tab, and select General from the Category field.
15. Enter <pmserver install dir>\bin\pmtx.lib in the Object/Library Modules field.
16. Click OK.
17. Choose Build-Build INF_BankSoft.dll or press F7 to build the project.
The compiler now creates the DLL and places it in the debug or release directory under
the project directory. For details on running a workflow with the debug version, see
“Running a Session with the Debug Version of the Module on Windows” on page 125.
To build shared libraries on UNIX:
1. If you cannot access the PowerCenter Client tools directly, copy all the files you need for
the shared library to the UNIX machine where you plan to perform the build. For
example, in the BankSoft procedure, use ftp or another mechanism to copy everything
from the INF_BankSoft directory to the UNIX machine.
124 Chapter 5: External Procedure Transformation
2. Set the environment variable PM_HOME to the PowerCenter installation directory.
Warning: If you specify an incorrect directory path for the PM_HOME environment
variable, the PowerCenter Server cannot start.
3. Enter the command to make the project.
The command depends on the version of UNIX, as summarized below:
UNIX Version Command
AIX (32-bit) make -f makefile.aix
AIX (64-bit) make -f makefile.aix64
HP-UX (32-bit) make -f makefile.hp
HP-UX (64-bit) make -f makefile.hp64
Linux make -f makefile.linux
Solaris make -f makefile.sol
Step 5. Create a Mapping
In the Mapping Designer, create a mapping that uses this External Procedure transformation.
Step 6. Run the Session in a Workflow
When you run the session in a workflow, the PowerCenter Server looks in the directory you
specify as the Runtime Location to find the library (DLL) you built in Step 4. The default
value of the Runtime Location property in the session properties is $PMExtProcDir.
To run a session in a workflow:
1. In the Workflow Manager, create a workflow.
2. Create a session for this mapping in the workflow.
Tip: Alternatively, you can create a re-usable session in the Task Developer and use it in
the workflow.
3. Copy the library (DLL) to the Runtime Location directory.
4. Run the workflow containing the session.
Running a Session with the Debug Version of the Module on Windows
Informatica ships PowerCenter on Windows with the release build (pmtx.dll) and the debug
build (pmtxdbg.dll) of the External Procedure transformation library. These libraries are
installed in the PowerCenter Server bin directory.
Developing Informatica External Procedures 125
If you build a release version of the module in Step 4, run the session in a workflow to
automatically use the release build (pmtx.dll) of the External Procedure transformation
library. You do not need to perform the following task.
If you build a debug version of the module in Step 4, follow the procedure below to use the
debug build (pmtxdbg.dll) of the External Procedure transformation library.
To run a session using a debug version of the module:
1. In the Workflow Manager, create a workflow.
2. Create a session for this mapping in the workflow.
Or, you can create a re-usable session in the Task Developer and use it in the workflow.
3. Copy the library (DLL) to the Runtime Location directory.
4. To use the debug build of the External Procedure transformation library:
♦ Preserve pmtx.dll by renaming it or moving it from the PowerCenter Server bin
directory.
♦ Rename pmtxdbg.dll to pmtx.dll.
5. Run the workflow containing the session.
6. To revert the release build of the External Procedure transformation library back to the
default library:
♦ Rename pmtx.dll back to pmtxdbg.dll.
♦ Return/rename the original pmtx.dll file to the PowerCenter Server bin directory.
Note: If you run a workflow containing this session with the debug version of the module on
Windows, you must return the original pmtx.dll file to its original name and location before
you can run a non-debug session.
126 Chapter 5: External Procedure Transformation
Distributing External Procedures
Suppose you develop a set of external procedures and you want to make them available on
multiple servers, each of which is running the PowerCenter Server. The methods for doing
this depend on the type of the external procedure and the operating system on which you
built it.
You can also use these procedures to distribute external procedures to external customers.
Distributing COM Procedures
Visual Basic and Visual C++ automatically register COM classes in the local registry when
you build the project. Once registered, these classes are accessible to the PowerCenter Server
running on the machine where you compiled the DLL. For example, if you build your project
on HOST1, all the classes in the project will be registered in the HOST1 registry and will be
accessible to the PowerCenter Server running on HOST1. Suppose, however, that you also
want the classes to be accessible to the PowerCenter Server running on HOST2. For this to
happen, the classes must be registered in the HOST2 registry.
Visual Basic provides a utility for creating a setup program that can install your COM classes
on a Windows machine and register these classes in the registry on that machine. While no
utility is available in Visual C++, you can easily register the class yourself.
Figure 5-1 illustration shows the process for distributing external procedures:
Figure 5-1. Process for Distributing External Procedures
Development PowerCenter Client PowerCenter Server
(Where external (Bring the DLL here to (Bring the DLL here to
procedure was run execute
developed using C++ regsvr32<xyz>.dll) regsvr32<xyz>.dll)
or VB)
To distribute a COM Visual Basic procedure:
1. After you build the DLL, exit Visual Basic and launch the Visual Basic Application Setup
wizard.
2. Skip the first panel of the wizard.
3. On the second panel, specify the location of your project and select the Create a Setup
Program option.
4. In the third panel, select the method of distribution you plan to use.
5. In the next panel, specify the directory to which you want to write the setup files.
Distributing External Procedures 127
For simple ActiveX components, you can continue to the final panel of the wizard.
Otherwise, you may need to add more information, depending on the type of file and the
method of distribution.
6. Click Finish in the final panel.
Visual Basic then creates the setup program for your DLL. Run this setup program on
any Windows machine where the PowerCenter Server is running.
To distribute a COM Visual C++/Visual Basic procedure manually:
1. Copy the DLL to the directory on the new Windows machine anywhere you want it
saved.
2. Log on to this Windows machine and open a DOS prompt.
3. Navigate to the directory containing the DLL and execute the following command:
REGSVR32 project_name.DLL
project_name is the name of the DLL you created. In the BankSoft example, the project
name is COM_VC_BankSoft.DLL. or COM_VB_BankSoft.DLL.
This command line program then registers the DLL and any COM classes contained in
it.
Distributing Informatica Modules
You can distribute external procedures between repositories.
To distribute external procedures between repositories:
1. Move the DLL or shared object that contains the external procedure to a directory on a
machine that the PowerCenter Server can access.
2. Copy the External Procedure transformation from the original repository to the target
repository using the Designer client tool.
or
Export the External Procedure transformation to an XML file and import it in the target
repository.
For details, see “Exporting and Importing Objects” in the Repository Guide.
128 Chapter 5: External Procedure Transformation
Development Notes
This section includes some additional guidelines and information about developing COM
and Informatica external procedures.
COM Datatypes
When using either Visual C++ or Visual Basic to develop COM procedures, you need to use
COM datatypes that correspond to the internal datatypes that the PowerCenter Server uses
when reading and transforming data. These datatype matches are important when the
PowerCenter Server attempts to map datatypes between ports in an External Procedure
transformation and arguments (or return values) from the procedure the transformation calls.
Table 5-2 compares Visual C++ and transformation datatypes:
Table 5-2. Visual C++ and Transformation Datatypes
Visual C++ COM Datatype Transformation Datatype
VT_I4 Integer
VT_UI4 Integer
VT_R8 Double
VT_BSTR String
VT_DECIMAL Decimal
VT_DATE Date/Time
Table 5-3 compares Visual Basic and the transformation datatypes:
Table 5-3. Visual Basic and Transformation Datatypes
Visual Basic COM Datatype Transformation Datatype
Long Integer
Double Double
String String
Decimal Decimal
Date Date/Time
If you do not correctly match datatypes, the PowerCenter Server may attempt a conversion.
For example, if you assign the Integer datatype to a port, but the datatype for the
corresponding argument is BSTR, the PowerCenter Server attempts to convert the Integer
value to a BSTR.
Development Notes 129
Row-Level Procedures
All External Procedure transformations call procedures using values from a single row passed
through the transformation. You cannot use values from multiple rows in a single procedure
call. For example, you could not code the equivalent of the aggregate functions SUM or AVG
into a procedure call. In this sense, all external procedures must be stateless.
Return Values from Procedures
When you call a procedure, the PowerCenter Server captures an additional return value
beyond whatever return value you code into the procedure. This additional value indicates
whether the PowerCenter Server successfully called the procedure.
For COM procedures, this return value uses the type HRESULT.
Informatica procedures use the type INF_RESULT. If the value returned is S_OK/
INF_SUCCESS, the PowerCenter Server successfully called the procedure. You must return
the appropriate value to indicate the success or failure of the external procedure. Informatica
procedures return four values:
♦ INF_SUCCESS. The external procedure processed the row successfully. The PowerCenter
Server passes the row to the next transformation in the mapping.
♦ INF_NO_OUTPUT_ROW. The PowerCenter Server does not write the current row due
to external procedure logic. This is not an error. When you use
INF_NO_OUTPUT_ROW to filter rows, the External Procedure transformation behaves
similarly to the Filter transformation.
Note: When you use INF_NO_OUTPUT_ROW in the external procedure, make sure you
connect the External Procedure transformation to another transformation that receives
rows from the External Procedure transformation only.
♦ INF_ROW_ERROR. Equivalent to a transformation error. The PowerCenter Server
discards the current row, but may process the next row unless you configure the session to
stop on n errors.
♦ INF_FATAL_ERROR. Equivalent to an ABORT() function call. The PowerCenter Server
aborts the session and does not process any more rows. For more information, see
“Functions” in the Transformation Language Reference.
Exceptions in Procedure Calls
The PowerCenter Server captures most exceptions that occur when it calls a COM or
Informatica procedure through an External Procedure transformation. For example, if the
procedure call creates a divide by zero error, the PowerCenter Server catches the exception.
In a few cases, the PowerCenter Server cannot capture errors generated by procedure calls.
Since the PowerCenter Server supports only in-process COM servers, and since all
Informatica procedures are stored in shared libraries and DLLs, the code running external
procedures exists in the same address space in memory as the PowerCenter Server. Therefore,
it is possible for the external procedure code to overwrite the PowerCenter Server memory,
130 Chapter 5: External Procedure Transformation
causing the PowerCenter Server to stop. If COM or Informatica procedures cause such stops,
review your source code for memory access problems.
Memory Management for Procedures
Since all the datatypes used in Informatica procedures are fixed length, there are no memory
management issues for Informatica external procedures. For COM procedures, you need to
allocate memory only if an [out] parameter from a procedure uses the BSTR datatype. In this
case, you need to allocate memory on every call to this procedure. During a session, the
PowerCenter Server releases the memory after calling the function.
Wrapper Classes for Pre-Existing C/C++ Libraries or VB Functions
Suppose that BankSoft has a library of C or C++ functions and wants to plug these functions
in to the PowerCenter Server. In particular, the library contains BankSoft’s own
implementation of the FV function, called PreExistingFV. The general method for doing this
is the same for both COM and Informatica external procedures. A similar solution is available
in Visual Basic. You need only make calls to preexisting Visual Basic functions or to methods
on objects that are accessible to Visual Basic.
Generating Error and Tracing Messages
The implementation of the Informatica external procedure TxINF_BankSoft::FV in “Step 4.
Building the Module” on page 123 contains the following lines of code.
ostrstream ss;
char* s;
...
ss << "The calculated future value is: " << FV->GetDouble() << ends;
s = ss.str();
(*m_pfnMessageCallback)(E_MSG_TYPE_LOG, 0, s);
(*m_pfnMessageCallback)(E_MSG_TYPE_ERR, 0, s);
delete [] s;
When the PowerCenter Server creates an object of type Tx<MODNAME>, it passes to its
constructor a pointer to a callback function that can be used to write error or debugging
messages to the session log. (The code for the Tx<MODNAME> constructor is in the file
Tx<MODNAME>.cpp.) This pointer is stored in the Tx<MODNAME> member variable
m_pfnMessageCallback. The type of this pointer is defined in a typedef in the file
$PMExtProcDir/include/infemmsg.h:
typedef void (*PFN_MESSAGE_CALLBACK)(
enum E_MSG_TYPE eMsgType,
unsigned long Code,
char* Message
);
Also defined in that file is the enumeration E_MSG_TYPE:
enum E_MSG_TYPE {
E_MSG_TYPE_LOG = 0,
Development Notes 131
E_MSG_TYPE_WARNING,
E_MSG_TYPE_ERR
};
If you specify the eMsgType of the callback function as E_MSG_TYPE_LOG, the callback
function will write a log message to your session log. If you specify E_MSG_TYPE_ERR, the
callback function writes an error message to your session log. If you specify
E_MSG_TYPE_WARNING, the callback function writes an warning message to your session
log. You can use these messages to provide a simple debugging capability in Informatica
external procedures.
To debug COM external procedures, you may use the output facilities available from inside a
Visual Basic or C++ class. For example, in Visual Basic you can use a MsgBox to print out the
result of a calculation for each row. Of course, you want to do this only on small samples of
data while debugging and make sure to remove the MsgBox before making a production run.
Note: Before attempting to use any output facilities from inside a Visual Basic or C++ class,
you must add the following value to the registry:
1. Add the following entry to the Windows registry:
\HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\PowerMart\Parameter
s\MiscInfo\RunInDebugMode=Yes
This option starts the PowerCenter Server as a regular application, not a service. This
allows you to debug the PowerCenter Server without changing the debug privileges for
the PowerCenter Server service while it is running.
2. Start the PowerCenter Server from the command line, using the command
PMSERVER.EXE.
The PowerCenter Server is now running in debug mode.
When you are finished debugging, make sure you remove this entry from the registry or set
RunInDebugMode to No. Otherwise, when you attempt to start PowerCenter as a service, it
will not start.
1. Stop the PowerCenter Server and change the registry entry you added earlier to the
following setting:
\HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\PowerMart\Parameter
s\MiscInfo\RunInDebugMode=No
2. Re-start the PowerCenter Server as a Windows service.
The TINFParam Class and Indicators
The <PROCNAME> method accesses input and output parameters using two parameter
arrays, and that each array element is of the TINFParam datatype. The TINFParam datatype
is a C++ class that serves as a “variant” data structure that can hold any of the Informatica
internal datatypes. The actual data in a parameter of type TINFParam* is accessed through
member functions of the form Get<Type> and Set<Type>, where <Type> is one of the
Informatica internal datatypes. TINFParam also has methods for getting and setting the
indicator for each parameter.
132 Chapter 5: External Procedure Transformation
You are responsible for checking these indicators on entry to the external procedure and for
setting them on exit. On entry, the indicators of all output parameters are explicitly set to
INF_SQL_DATA_NULL, so if you do not reset these indicators before returning from the
external procedure, you will just get NULLs for all the output parameters. The TINFParam
class also supports functions for obtaining the metadata for a particular parameter. For a
complete description of all the member functions of the TINFParam class, see the infemdef.h
include file in the tx/include directory.
Note that one of the main advantages of Informatica external procedures over COM external
procedures is that Informatica external procedures directly support indicator manipulation.
That is, you can check an input parameter to see if it is NULL, and you can set an output
parameter to NULL. COM provides no indicator support. Consequently, if a row entering a
COM-style external procedure has any NULLs in it, the row cannot be processed. You can use
the default value facility in the Designer to overcome this shortcoming. However, it is not
possible to pass NULLs out of a COM function.
Unconnected External Procedure Transformations
When you add an instance of an External Procedure transformation to a mapping, you can
choose to connect it as part of the pipeline or leave it unconnected. Connected External
Procedure transformations call the COM or Informatica procedure every time a row passes
through the transformation.
To get return values from an unconnected External Procedure transformation, call it in an
expression using the following syntax:
:EXT.transformation_name(arguments)
When a row passes through the transformation containing the expression, the PowerCenter
Server calls the procedure associated with the External Procedure transformation. The
expression captures the return value of the procedure through the External Procedure
transformation return port, which should have the Result (R) option checked. For more
information about expressions, see “Transformations” in the Designer Guide.
Initializing COM and Informatica Modules
Some external procedures must be configured at initialization time. This initialization takes
one of two forms, depending on the type of the external procedure:
1. Initialization of Informatica-style external procedures. The Tx<MODNAME> class,
which contains the external procedure, also contains the initialization function,
Tx<MODNAME>::InitDerived. The signature of this initialization function is well-
known to the PowerCenter Server and consists of three parameters:
♦ nInitProps. This parameter tells the initialization function how many initialization
properties are being passed to it.
♦ Properties. This parameter is an array of nInitProp strings representing the names of
the initialization properties.
Development Notes 133
♦ Values. This parameter is an array of nInitProp strings representing the values of the
initialization properties:
The PowerCenter Server first calls the Init() function in the base class. When the Init()
function successfully completes, the base class calls the Tx<MODNAME>::InitDerived()
function.
The PowerCenter Server creates the Tx<MODNAME> object and then calls the
initialization function. It is the responsibility of the external procedure developer to
supply that part of the Tx<MODNAME>::InitDerived() function that interprets the
initialization properties and uses them to initialize the external procedure. Once the
object is created and initialized, the PowerCenter Server can call the external procedure
on the object for each row.
2. Initialization of COM-style external procedures. The object that contains the external
procedure (or EP object) does not contain an initialization function. Instead, another
object (the CF object) serves as a class factory for the EP object. The CF object has a
method that can create an EP object.
The exact signature of the CF object method is determined from its type library. The
PowerCenter Server creates the CF object, then calls the method on it to create the EP
object, passing this method whatever parameters are required. This requires that the
signature of the method consist of a set of input parameters, whose types can be
determined from the type library, followed by a single output parameter that is an
IUnknown** or an IDispatch** or a VARIANT* pointing to an IUnknown* or
IDispatch*.
The input parameters hold the values required to initialize the EP object and the output
parameter receives the initialized object. The output parameter can have either the [out]
or the [out, retval] attributes. That is, the initialized object can be returned either as an
134 Chapter 5: External Procedure Transformation
output parameter or as the return value of the method. The datatypes supported for the
input parameters are:
♦ COM VC type
♦ VT_UI1
♦ VT_BOOL
♦ VT_I2
♦ VT_UI2
♦ VT_I4
♦ VT_UI4
♦ VT_R4
♦ VT_R8
♦ VT_BSTR
♦ VT_CY
♦ VT_DATE
Setting Initialization Properties in the Designer
Enter external procedure initialization properties on the Initialization Properties tab of the
Edit Transformations dialog box. The tab displays different fields, depending on whether the
external procedure is COM-style or Informatica-style.
COM-style External Procedure transformations contain the following fields on the
Initialization Properties tab:
♦ Programmatic Identifier for Class Factory. Enter the programmatic identifier of the class
factory.
♦ Constructor. Specify the method of the class factory that creates the EP object.
Development Notes 135
Figure 5-2 shows the Initialization Properties tab of a COM-style External Procedure
transformation:
Figure 5-2. External Procedure Transformation Initialization Properties
Add a new property.
New Property
You can enter an unlimited number of initialization properties to pass to the Constructor
method for both COM-style and Informatica-style External Procedure transformations.
To add a new initialization property, click the Add button. Enter the name of the parameter
in the Property column and enter the value of the parameter in the Value column. For
example, you can enter the following parameters:
Parameter Value
Param1 abc
Param2 100
Param3 3.17
Note: You must create a one-to-one relation between the initialization properties you define in
the Designer and the input parameters of the class factory constructor method. For example,
if the constructor has n parameters with the last parameter being the output parameter that
receives the initialized object, you must define n – 1 initialization properties in the Designer,
one for each input parameter in the constructor method.
You can also use server variables in initialization properties. For information on server
variables support in Initialization properties, see “Server Variables Support in Initialization
Properties” on page 138.
136 Chapter 5: External Procedure Transformation
Other Files Distributed and Used in TX
Following are the header files located under the path $PMExtProcDir/include that are needed
for compiling external procedures:
♦ infconfg.h
♦ infem60.h
♦ infemdef.h
♦ infemmsg.h
♦ infparam.h
♦ infsigtr.h
Following are the library files located under the path <PMInstallDir> that are needed for
linking external procedures and running the session:
♦ libpmtx.a (AIX)
♦ libpmtx.sl (HP-UX)
♦ libpmtx.so (Linux)
♦ libpmtx.so (Solaris)
♦ pmtx.dll and pmtx.lib (Windows)
Development Notes 137
Server Variables Support in Initialization Properties
PowerCenter supports built-in server variables in the External Procedure transformation
initialization properties list. If the property values contain built-in server variables, the
PowerCenter Server expands them before passing them to the external procedure library. This
can be very useful for writing portable External Procedure transformations.
Figure 5-3 shows an External Procedure transformation with five user-defined properties:
Figure 5-3. External Procedure Transformation Initialization Properties Tab
Table 5-4 contains the initialization properties and values for the External Procedure
transformation in Figure 5-3:
Table 5-4. External Procedure Initialization Properties
Property Value Expanded Value Passed to the External Procedure Library
mytempdir $PMTempDir /tmp
memorysize 5000000 5000000
input_file $PMSourceFileDir/file.in /data/input/file.in
output_file $PMTargetFileDir/file.out /data/output/file.out
extra_var $some_other_variable $some_other_variable
When you run the workflow, the PowerCenter Server expands the property list and passes it
to the external procedure initialization function. Assuming that the values of the built-in
server variables $PMTempDir is /tmp, $PMSourceFileDir is /data/input, and
$PMTargetFileDir is /data/output, the last column in Table 5-4 contains the property and
expanded value information. Note that the PowerCenter Server does not expand the last
property “$some_other_variable” because it is not a built-in server variable.
138 Chapter 5: External Procedure Transformation
External Procedure Interfaces
The PowerCenter Server uses the following major functions with External Procedures:
♦ Dispatch
♦ External procedure
♦ Property access
♦ Parameter access
♦ Code page access
♦ Transformation name access
♦ Procedure access
♦ Partition related
♦ Tracing level
Dispatch Function
The PowerCenter Server calls the dispatch function to pass each input row to the external
procedure module. The dispatch function, in turn, calls the external procedure function you
specify.
External procedures access the ports in the transformation directly using the member variable
m_pInParamVector for input ports and m_pOutParamVector for output ports.
Signature
The dispatch function has a fixed signature which includes one index parameter.
virtual INF_RESULT Dispatch(unsigned long ProcedureIndex) = 0
External Procedure Function
The external procedure function is the main entry point into the external procedure module,
and is an attribute of the External Procedure transformation. The dispatch function calls the
external procedure function for every input row. For External Procedure transformations, use
the external procedure function for input and output from the external procedure module.
The function can access the IN and IN-OUT port values for every input row, and can set the
OUT and IN-OUT port values. The external procedure function contains all the input and
output processing logic.
Signature
The external procedure function has no parameters. The input parameter array is already
passed through the InitParams() method and stored in the member variable
m_pInParamVector. Each entry in the array matches the corresponding IN and IN-OUT
External Procedure Interfaces 139
ports of the External Procedure transformation, in the same order. The PowerCenter Server
fills this vector before calling the dispatch function.
Use the member variable m_pOutParamVector to pass the output row before returning the
Dispatch() function.
For the MyExternal Procedure transformation, the external procedure function is the
following, where the input parameters are in the member variable m_pInParamVector and the
output values are in the member variable m_pOutParamVector:
INF_RESULT Tx<ModuleName>::MyFunc()
Property Access Functions
The property access functions provide information about the initialization properties
associated with the External Procedure transformation. The initialization property names and
values appear on the Initialization Properties tab when you edit the External Procedure
transformation.
Informatica provides property access functions in both the base class and the
TINFConfigEntriesList class. Use the GetConfigEntryName() and GetConfigEntryValue()
functions in the TINFConfigEntriesList class to access the initialization property name and
value, respectively.
Signature
Informatica provides the following functions in the base class:
TINFConfigEntriesList*
TINFBaseExternalModule60::accessConfigEntriesList();
const char* GetConfigEntry(const char* LHS);
Informatica provides the following functions in the TINFConfigEntriesList class:
const char* TINFConfigEntriesList::GetConfigEntryValue(const char* LHS);
const char* TINFConfigEntriesList::GetConfigEntryValue(int i);
const char* TINFConfigEntriesList::GetConfigEntryName(int i);
const char* TINFConfigEntriesList::GetConfigEntry(const char* LHS)
Note: In the TINFConfigEntriesList class, Informatica recommends using the
GetConfigEntryName() and GetConfigEntryValue() property access functions to access the
initialization property names and values.
You can call these functions from a TX program. The TX program then converts this string
value into a number, for example by using atoi or sscanf. In the following example,
“addFactor” is an Initialization Property. accessConfigEntriesList() is a member variable of the
TX base class and does not need to be defined.
const char* addFactorStr = accessConfigEntriesList()->
GetConfigEntryValue("addFactor");
140 Chapter 5: External Procedure Transformation
Parameter Access Functions
Parameter access functions are datatype specific. Use the parameter access function
GetDataType to return the datatype of a parameter. Then use a parameter access function
corresponding to this datatype to return information about the parameter.
A parameter passed to an external procedure belongs to the datatype TINFParam*. The
header file infparam.h defines the related access functions. The Designer generates stub code
that includes comments indicating the parameter datatype. You can also determine the
datatype of a parameter in the corresponding External Procedure transformation in the
Designer.
Signature
A parameter passed to an external procedure is a pointer to an object of the TINFParam class.
This fixed-signature function is a method of that class and returns the parameter datatype as
an enum value.
The valid datatypes are:
INF_DATATYPE_LONG
INF_DATATYPE_STRING
INF_DATATYPE_DOUBLE
INF_DATATYPE_RAW
INF_DATATYPE_TIME
Table 5-5 lists a brief description of some parameter access functions:
Table 5-5. Descriptions of Parameter Access Functions
Parameter Access Function Description
INF_DATATYPE GetDataType(void); Gets the datatype of a parameter. Use the parameter datatype to
determine which datatype-specific function to use when accessing
parameter values.
INF_Boolean IsValid(void); Checks if input data is valid. Returns FALSE if the parameter contains
truncated data and is a string.
INF_Boolean IsNULL(void); Checks if input data is NULL.
INF_Boolean IsInputMapped (void); Checks if input port passing data to this parameter is connected to a
transformation.
INF_Boolean IsOutput Mapped (void); Checks if output port receiving data from this parameter is connected to
a transformation.
INF_Boolean IsInput(void); Checks if parameter corresponds to an input port.
INF_Boolean IsOutput(void); Checks if parameter corresponds to an output port.
INF_Boolean GetName(void); Gets the name of the parameter.
External Procedure Interfaces 141
Table 5-5. Descriptions of Parameter Access Functions
Parameter Access Function Description
SQLIndicator GetIndicator(void); Gets the value of a parameter indicator. The IsValid and ISNULL
functions are special cases of this function. This function can also return
INF_SQL_DATA_TRUNCATED.
void SetIndicator(SQLIndicator Indicator); Sets an output parameter indicator, such as invalid or truncated.
long GetLong(void); Gets the value of a parameter having a Long or Integer datatype. Call
this function only if you know the parameter datatype is Integer or Long.
This function does not convert data to Long from another datatype.
double GetDouble(void); Gets the value of a parameter having a Float or Double datatype. Call
this function only if you know the parameter datatype is Float or Double.
This function does not convert data to Double from another datatype.
char* GetString(void); Gets the value of a parameter as a null-terminated string. Call this
function only if you know the parameter datatype is String. This function
does not convert data to String from another datatype.
The value in the pointer changes when the next row of data is read. If
you want to store the value from a row for later use, explicitly copy this
string into its own allocated buffer.
char* GetRaw(void); Gets the value of a parameter as a non-null terminated byte array. Call
this function only if you know the parameter datatype is Raw. This
function does not convert data to Raw from another datatype.
unsigned long GetActualDataLen(void); Gets the current length of the array returned by GetRaw.
TINFTime GetTime(void); Gets the value of a parameter having a Date/Time datatype. Call this
function only if you know the parameter datatype is Date/Time. This
function does not convert data to Date/Time from another datatype.
void SetLong(long lVal); Sets the value of an output parameter having a Long datatype.
void SetDouble(double dblVal); Sets the value of an output parameter having a Double datatype.
void SetString(char* sVal); Sets the value of an output parameter having a String datatype.
void SetRaw(char* rVal, size_t Sets a non-null terminated byte array.
ActualDataLen);
void SetTime(TINFTime timeVal); Sets the value of an output parameter having a Date/Time datatype.
Only use the SetInt32 or GetInt32 function when you run the external procedure on a 64-bit
PowerCenter Server. Do not use any of the following functions:
♦ GetLong
♦ SetLong
♦ GetpLong
♦ GetpDouble
♦ GetpTime
Pass the parameters using two parameter lists.
142 Chapter 5: External Procedure Transformation
Table 5-6 lists the member variables of the external procedure base class.
Table 5-6. Member Variable of the External Procedure Base Class
Variable Description
m_nInParamCount Number of input parameters.
m_pInParamVector Actual input parameter array.
m_nOutParamCount Number of output parameters.
m_pOutParamVector Actual output parameter array.
Ports defined as input/output show up in both parameter lists.
Code Page Access Functions
Informatica provides two code page access functions that return the code page of the
PowerCenter Server and two that return the code page of the data the external procedure
processes. When the PowerCenter Server runs in Unicode mode, the string data passing to the
external procedure program can contain multibyte characters. The code page determines how
the external procedure interprets a multibyte character string. When the PowerCenter Server
runs in Unicode mode, data processed by the external procedure program must be two-way
compatible with the PowerCenter Server code page.
Signature
Use the following functions to obtain the PowerCenter Server code page through the external
procedure program. Both functions return equivalent information.
int GetServerCodePageID() const;
const char* GetServerCodePageName() const;
Use the following functions to obtain the code page of the data the external procedure
processes through the external procedure program. Both functions return equivalent
information.
int GetDataCodePageID(); // returns 0 in case of error
const char* GetDataCodePageName() const; // returns NULL in case of error
Transformation Name Access Functions
Informatica provides two transformation name access functions that return the name of the
External Procedure transformation. The GetWidgetName() function returns the name of the
transformation, and the GetWidgetInstanceName() function returns the name of the
transformation instance in the mapplet or mapping.
External Procedure Interfaces 143
Signature
The char* returned by the transformation name access functions is an MBCS string in the
code page of the PowerCenter Server. It is not in the data code page.
const char* GetWidgetInstanceName() const;
const char* GetWidgetName() const;
Procedure Access Functions
Informatica provides two procedure access functions that provide information about the
external procedure associated with the External Procedure transformation. The
GetProcedureName() function returns the name of the external procedure specified in the
Procedure Name field of the External Procedure transformation. The GetProcedureIndex()
function returns the index of the external procedure.
Signature
Use the following function to get the name of the external procedure associated with the
External Procedure transformation:
const char* GetProcedureName() const;
Use the following function to get the index of the external procedure associated with the
External Procedure transformation:
inline unsigned long GetProcedureIndex() const;
Partition Related Functions
Use partition related functions for external procedures in sessions with multiple partitions.
When you partition a session that contains External Procedure transformations, the
PowerCenter Server creates instances of these transformations for each partition. For example,
if you define five partitions for a session, the PowerCenter Server creates five instances of each
external procedure at session runtime.
Signature
Use the following function to obtain the number of partitions in a session:
unsigned long GetNumberOfPartitions();
Use the following function to obtain the index of the partition that called this external
procedure:
unsigned long GetPartitionIndex();
144 Chapter 5: External Procedure Transformation
Tracing Level Function
The tracing level function returns the session trace level, for example:
typedef enum
{
TRACE_UNSET = 0,
TRACE_TERSE = 1,
TRACE_NORMAL = 2,
TRACE_VERBOSE_INIT = 3,
TRACE_VERBOSE_DATA = 4
} TracingLevelType;
Signature
Use the following function to return the session trace level:
TracingLevelType GetSessionTraceLevel();
External Procedure Interfaces 145
146 Chapter 5: External Procedure Transformation
Chapter 6
Filter Transformation
This chapter covers the following topics:
♦ Overview, 148
♦ Filter Condition, 150
♦ Creating a Filter Transformation, 151
♦ Tips, 153
♦ Troubleshooting, 154
147
Overview
Transformation type:
Connected
Active
The Filter transformation allows you to filter rows in a mapping. You pass all the rows from a
source transformation through the Filter transformation, and then enter a filter condition for
the transformation. All ports in a Filter transformation are input/output, and only rows that
meet the condition pass through the Filter transformation.
In some cases, you need to filter data based on one or more conditions before writing it to
targets. For example, if you have a human resources target containing information about
current employees, you might want to filter out employees who are part-time and hourly.
The mapping in Figure 6-1 passes the rows from a human resources table that contains
employee data through a Filter transformation. The filter only allows rows through for
employees that make salaries of $30,000 or higher.
Figure 6-1. Sample Mapping With a Filter Transformation
148 Chapter 6: Filter Transformation
Figure 6-2 shows the filter condition used in the mapping in Figure 6-1 on page 148:
Figure 6-2. Specifying a Filter Condition in a Filter Transformation
With the filter of SALARY > 30000, only rows of data where employees that make salaries
greater than $30,000 pass through to the target.
As an active transformation, the Filter transformation may change the number of rows passed
through it. A filter condition returns TRUE or FALSE for each row that passes through the
transformation, depending on whether a row meets the specified condition. Only rows that
return TRUE pass through this transformation. Discarded rows do not appear in the session
log or reject files.
To maximize session performance, include the Filter transformation as close to the sources in
the mapping as possible. Rather than passing rows you plan to discard through the mapping,
you then filter out unwanted data early in the flow of data from sources to targets.
You cannot concatenate ports from more than one transformation into the Filter
transformation. The input ports for the filter must come from a single transformation. The
Filter transformation does not allow setting output default values.
Overview 149
Filter Condition
You use the transformation language to enter the filter condition. The condition is an
expression that returns TRUE or FALSE. For example, if you want to filter out rows for
employees whose salary is less than $30,000, you enter the following condition:
SALARY > 30000
You can specify multiple components of the condition, using the AND and OR logical
operators. If you want to filter out employees who make less than $30,000 and more than
$100,000, you enter the following condition:
SALARY > 30000 AND SALARY < 100000
You do not need to specify TRUE or FALSE as values in the expression. TRUE and FALSE
are implicit return values from any condition you set. If the filter condition evaluates to
NULL, the row is assumed to be FALSE.
Enter conditions using the Expression Editor, available from the Properties tab of the Filter
transformation. The filter condition is case-sensitive. Any expression that returns a single
value can be used as a filter. You can also enter a constant for the filter condition. The
numeric equivalent of FALSE is zero (0). Any non-zero value is the equivalent of TRUE. For
example, if you have a port called NUMBER_OF_UNITS with a numeric datatype, a filter
condition of NUMBER_OF_UNITS returns FALSE if the value of NUMBER_OF_UNITS
equals zero. Otherwise, the condition returns TRUE.
After entering the expression, you can validate it by clicking the Validate button in the
Expression Editor. When you enter an expression, validate it before continuing to avoid
saving an invalid mapping to the repository. If a mapping contains syntax errors in an
expression, you cannot run any session that uses the mapping until you correct the error.
150 Chapter 6: Filter Transformation
Creating a Filter Transformation
Creating a Filter transformation requires inserting the new transformation into the mapping,
adding the appropriate input/output ports, and writing the condition.
To create a Filter transformation:
1. In the Designer, switch to the Mapping Designer and open a mapping.
2. Choose Transformation-Create.
Select Filter transformation, and enter the name of the new transformation. The naming
convention for the Filter transformation is FIL_TransformationName. Click Create, and
then click Done.
3. Select and drag all the desired ports from a source qualifier or other transformation to
add them to the Filter transformation.
After you select and drag ports, copies of these ports appear in the Filter transformation.
Each column has both an input and an output port.
4. Double-click the title bar of the new transformation.
5. Click the Properties tab.
A default condition appears in the list of conditions. The default condition is TRUE (a
constant with a numeric value of 1).
Open Button
6. Click the Value section of the condition, and then click the Open button.
The Expression Editor appears.
Creating a Filter Transformation 151
7. Enter the filter condition you want to apply.
Use values from one of the input ports in the transformation as part of this condition.
However, you can also use values from output ports in other transformations.
8. Click Validate to check the syntax of the conditions you entered.
You may have to fix syntax errors before continuing.
9. Click OK.
10. Select the desired Tracing Level, and click OK to return to the Mapping Designer.
11. Choose Repository-Save to save the mapping.
152 Chapter 6: Filter Transformation
Tips
The following tips can help filter performance:
Use the Filter transformation early in the mapping.
To maximize session performance, keep the Filter transformation as close as possible to the
sources in the mapping. Rather than passing rows that you plan to discard through the
mapping, you can filter out unwanted data early in the flow of data from sources to targets.
Use the Source Qualifier transformation to filter.
The Source Qualifier transformation provides an alternate way to filter rows. Rather than
filtering rows from within a mapping, the Source Qualifier transformation filters rows when
read from a source. The main difference is that the source qualifier limits the row set extracted
from a source, while the Filter transformation limits the row set sent to a target. Since a source
qualifier reduces the number of rows used throughout the mapping, it provides better
performance.
However, the Source Qualifier transformation only lets you filter rows from relational sources,
while the Filter transformation filters rows from any type of source. Also, note that since it
runs in the database, you must make sure that the filter condition in the Source Qualifier
transformation only uses standard SQL. The Filter transformation can define a condition
using any statement or transformation function that returns either a TRUE or FALSE value.
For more information about setting a filter for a Source Qualifier transformation, see “Source
Qualifier Transformation” on page 293.
Tips 153
Troubleshooting
I imported a flat file into another database (Microsoft Access) and used SQL filter queries
to determine the number of rows to import into the Designer. But when I import the flat
file into the Designer and pass data through a Filter transformation using equivalent SQL
statements, I do not import as many rows. Why is there a difference?
You might want to check two possible solutions:
♦ Case sensitivity. The filter condition is case-sensitive, and queries in some databases do
not take this into account.
♦ Appended spaces. If a field contains additional spaces, the filter condition needs to check
for additional spaces for the length of the field. Use the RTRIM function to remove
additional spaces.
How do I filter out rows with null values?
To filter out rows containing null values or spaces, use the ISNULL and IS_SPACES
functions to test the value of the port. For example, if you want to filter out rows that contain
NULLs in the FIRST_NAME port, use the following condition:
IIF(ISNULL(FIRST_NAME),FALSE,TRUE)
This condition states that if the FIRST_NAME port is NULL, the return value is FALSE and
the row should be discarded. Otherwise, the row passes through to the next transformation.
For more information about the ISNULL and IS_SPACES functions, see “Functions” in the
Transformation Language Reference.
154 Chapter 6: Filter Transformation
Chapter 7
Joiner Transformation
This chapter covers the following topics:
♦ Overview, 156
♦ Joiner Transformation Properties, 157
♦ Defining a Join Condition, 159
♦ Defining the Join Type, 160
♦ Using Sorted Input, 163
♦ Using Joiner Transformations in Mappings, 167
♦ PowerCenter Server Processing, 170
♦ Creating a Joiner Transformation, 172
♦ Tips, 176
155
Overview
Transformation type:
Connected
Active
You can use the Joiner transformation to join source data from two related heterogeneous
sources residing in different locations or file systems. Or, you can join data from the same
source.
The Joiner transformation joins two sources with at least one matching port. The Joiner
transformation uses a condition that matches one or more pairs of ports between the two
sources. If you need to join more than two sources, you can add more Joiner transformations
to the mapping.
The Joiner transformation requires input from two separate pipelines or two branches from
one pipeline.
In the following example, the Aggregator transformation and the Source Qualifier
transformation are the input transformations for the Joiner transformation.
Figure 7-1 shows the Joiner transformation joining two pipelines:
Figure 7-1. Sample Mapping with a Joiner Transformation
The Joiner transformation accepts input from most transformations. However, there are some
limitations on the pipelines you connect to the Joiner transformation. You cannot use a Joiner
transformation in the following situations:
♦ Either input pipeline contains an Update Strategy transformation.
♦ You connect a Sequence Generator transformation directly before the Joiner
transformation.
If you have the partitioning option in PowerCenter, you can increase the number of partitions
in a pipeline to improve session performance. For information about partitioning restrictions
that apply to the Joiner transformation, see the Workflow Administration Guide.
156 Chapter 7: Joiner Transformation
Joiner Transformation Properties
Properties for the Joiner transformation identify the location of the cache directory, how the
PowerCenter Server processes the transformation, and how it handles caching. The properties
also determine how the PowerCenter Server joins tables and files.
Figure 7-2 shows the Joiner transformation properties:
Figure 7-2. The Joiner Transformation Properties Tab
When you create a mapping, you specify the properties for each Joiner transformation. When
you create a session, you can override some properties, such as the index and data cache size
for each transformation.
Table 7-1 describes the Joiner transformation properties:
Table 7-1. Joiner Transformation Properties
Option Description
Case-Sensitive String Comparison If selected, the PowerCenter Server uses case-sensitive string comparisons when
performing joins on string columns.
Cache Directory Specifies the directory used to cache master or detail rows and the index to these
rows. By default, the cache files are created in a directory specified by the server
variable $PMCacheDir. If you override the directory, make sure the directory
exists and contains enough disk space for the cache files. The directory can be a
mapped or mounted drive.
Join Type Specifies the type of join: Normal, Master Outer, Detail Outer, or Full Outer.
Null Ordering in Master Not applicable for this transformation type.
Joiner Transformation Properties 157
Table 7-1. Joiner Transformation Properties
Option Description
Null Ordering in Detail Not applicable for this transformation type.
Tracing Level Amount of detail displayed in the session log for this transformation. The options
are Terse, Normal, Verbose Data, and Verbose Initialization.
Joiner Data Cache Size Data cache size for the transformation. Default cache size is 2,000,000 bytes. If
the total configured cache size is 2 GB (2,147,483,648) or more, you must run the
session on a 64-bit PowerCenter Server.
Joiner Index Cache Size Index cache size for the transformation. Default cache size is 1,000,000 bytes. If
the total configured cache size is 2 GB (2,147,483,648) or more, you must run the
session on a 64-bit PowerCenter Server.
Sorted Input Specifies that data is sorted. Choose Sorted Input to join sorted data. Using
sorted input can improve performance. For more information about working with
sorted input, see “Using Sorted Input” on page 163.
Transformation Scope Specifies how the PowerCenter Server applies the transformation logic to
incoming data:
- Transaction. Applies the transformation logic to all rows in a transaction.
Choose Transaction when a row of data depends on all rows in the same
transaction, but does not depend on rows in other transactions.
- All Input. Applies the transformation logic on all incoming data. When you
choose All Input, the PowerCenter drops incoming transaction boundaries.
Choose All Input when a row of data depends on all rows in the source.
You can only choose Transaction when the Joiner transformation joins data from
the same source, either two branches of the same pipeline or two output groups of
one transaction generator, such as an XML Source Qualifier transformation.
When you define the transformation scope to Transaction, you must verify that the
master and detail pipelines originate from the same transaction control point.
For more information about transformation scope, see “Understanding Commit
Points” in the Workflow Administration Guide.
158 Chapter 7: Joiner Transformation
Defining a Join Condition
The join condition contains ports from both input sources that must match for the
PowerCenter Server to join two rows. Depending on the type of join selected, the Joiner
transformation either adds the row to the result set or discards the row. The Joiner produces
result sets based on the join type, condition, and input data sources.
Before you define a join condition, verify that the master and detail sources are set for optimal
performance. During a session, the PowerCenter Server compares each row of the master
source against the detail source. The fewer unique rows in the master, the fewer iterations of
the join comparison occur, which speeds the join process. To improve performance, designate
the source with the smallest count of distinct values as the master.
By default, when you add ports to a Joiner transformation, the ports from the first source
display as detail sources. Adding the ports from the second transformation sets them as master
sources. To change these settings, click the M column on the Ports tab for the ports you want
to set as the master source. This sets ports from this source as master ports and ports from the
other source as detail ports.
You define one or more conditions based on equality between the specified master and detail
sources. Join conditions only support equality between fields. For example, if two sources
with tables called EMPLOYEE_AGE and EMPLOYEE_POSITION both contain employee
ID numbers, the following condition matches rows with employees listed in both sources:
EMP_ID1 = EMP_ID2
You can use one or more ports from the input sources of a Joiner transformation in the join
condition. Additional ports increase the time necessary to join two sources. The order of the
ports in the condition can impact the performance of the Joiner transformation. If you use
multiple ports in the join condition, the PowerCenter Server compares the ports in the order
you specify.
The Designer validates datatypes in a condition. Both ports in a condition must have the
same datatype. If you need to use two ports in the condition with non-matching datatypes,
convert the datatypes so they match.
If you join Char and Varchar datatypes, the PowerCenter Server counts any spaces that pad
Char values as part of the string. So if you try to join the following:
Char(40) = “abcd”
Varchar(40) = “abcd”
Then the Char value is “abcd” padded with 36 blank spaces, and the PowerCenter Server does
not join the two fields because the Char field contains trailing spaces.
Note: The Joiner transformation does not match null values. For example, if both EMP_ID1
and EMP_ID2 from the example above contain a row with a null value, the PowerCenter
Server does not consider them a match and does not join the two rows. To join rows with null
values, you can replace null input with default values, and then join on the default values. For
details on default values, see “Transformations” in the Designer Guide.
Defining a Join Condition 159
Defining the Join Type
In SQL, a join is a relational operator that combines data from multiple tables into a single
result set. The Joiner transformation acts in much the same manner, except that tables can
originate from different databases or flat files.
You define the join type on the Properties tab in the transformation. The Joiner
transformation supports the following types of joins:
♦ Normal
♦ Master Outer
♦ Detail Outer
♦ Full Outer
Note: A normal or master outer join performs faster than a full outer or detail outer join.
If a result set includes fields that do not contain data in either of the sources, the Joiner
transformation populates the empty fields with null values. If you know that a field will
return a NULL but would rather not insert NULLs in your target, you can set a default value
in the Ports tab for the corresponding port.
Normal Join
With a normal join, the PowerCenter Server discards all rows of data from the master and
detail source that do not match, based on the condition.
For example, you might have two sources of data for auto parts called PARTS_SIZE and
PARTS_COLOR with the following data:
PARTS_SIZE (master source)
PART_ID1 DESCRIPTION SIZE
1 Seat Cover Large
2 Ash Tray Small
3 Floor Mat Medium
PARTS_COLOR (detail source)
PART_ID2 DESCRIPTION COLOR
1 Seat Cover Blue
3 Floor Mat Black
4 Fuzzy Dice Yellow
To join the two tables by matching the PART_IDs in both sources, you set the condition as
follows:
PART_ID1 = PART_ID2
160 Chapter 7: Joiner Transformation
When you join these tables with a normal join, the result set includes:
PART_ID DESCRIPTION SIZE COLOR
1 Seat Cover Large Blue
3 Floor Mat Medium Black
The equivalent SQL statement would be:
SELECT * FROM PARTS_SIZE, PARTS_COLOR WHERE PARTS_SIZE.PART_ID1 =
PARTS_COLOR.PART_ID2
Master Outer Join
A master outer join keeps all rows of data from the detail source and the matching rows from
the master source. It discards the unmatched rows from the master source.
When you join the sample tables with a master outer join and the same condition, the result
set includes:
PART_ID DESCRIPTION SIZE COLOR
1 Seat Cover Large Blue
3 Floor Mat Medium Black
4 Fuzzy Dice NULL Yellow
Notice that since no size is specified for the Fuzzy Dice, the PowerCenter Server populates the
field with a NULL.
The equivalent SQL statement would be:
SELECT * FROM PARTS_SIZE LEFT OUTER JOIN PARTS_COLOR ON
(PARTS_SIZE.PART_ID = PARTS_COLOR.PART_ID)
Detail Outer Join
A detail outer join keeps all rows of data from the master source and the matching rows from
the detail source. It discards the unmatched rows from the detail source.
When you join the sample tables with a detail outer join and the same condition, the result
set includes:
PART_ID DESCRIPTION SIZE COLOR
1 Seat Cover Large Blue
2 Ash Tray Small NULL
3 Floor Mat Medium Black
Notice that since no color is specified for the Ash Tray, the PowerCenter Server populates the
field with a NULL.
Defining the Join Type 161
The equivalent SQL statement would be:
SELECT * FROM PARTS_SIZE RIGHT OUTER JOIN PARTS_COLOR ON
(PARTS_COLOR.PART_ID = PARTS_SIZE.PART_ID)
Full Outer Join
A full outer join keeps all rows of data from both the master and detail sources.
When you join the sample tables with a full outer join and the same condition, the result set
includes:
PART_ID DESCRIPTION SIZE Color
1 Seat Cover Large Blue
2 Ash Tray Small NULL
3 Floor Mat Medium Black
4 Fuzzy Dice NULL Yellow
Notice that since no color is specified for the Ash Tray and no size is specified for the Fuzzy
Dice, the PowerCenter Server populates the fields with a NULL.
The equivalent SQL statement would be:
SELECT * FROM PARTS_SIZE FULL OUTER JOIN PARTS_COLOR ON
(PARTS_SIZE.PART_ID = PARTS_COLOR.PART_ID)
162 Chapter 7: Joiner Transformation
Using Sorted Input
You can improve session performance by configuring the Joiner transformation to use sorted
input. When you configure the Joiner transformation to use sorted data, the PowerCenter
Server improves performance by minimizing disk input and output. You see the greatest
performance improvement when you work with large data sets.
To configure the mapping to use sorted data, you establish and maintain a sort order in the
mapping so the PowerCenter Server can use the sorted data when it processes the Joiner
transformation. Complete the following tasks to configure the mapping:
♦ Configure the sort order. Configure the sort order of the data you want to join. You can
join sorted flat files, or you can sort relational data using a Source Qualifier
transformation. You can also use a Sorter transformation.
♦ Add transformations. Use transformations that maintain the order of the sorted data.
♦ Configure the Joiner transformation. Configure the Joiner transformation to use sorted
data and configure the join condition to use the sort origin ports. The sort origin
represents the source of the sorted data.
When you configure the sort order in a session, the Workflow Manager allows you to select a
sort order associated with the PowerCenter Server code page. When you run the PowerCenter
Server in Unicode mode, it uses the selected session sort order to sort character data. When
you run the PowerCenter Server in ASCII mode, it sorts all character data using a binary sort
order. To ensure that data is sorted as the PowerCenter Server requires, the database sort order
must be the same as the user-defined session sort order.
When you join sorted data from partitioned pipelines, you must configure the partitions to
maintain the order of sorted data. For more information about joining data from partitioned
pipelines, see the Workflow Administration Guide.
Configuring the Sort Order
You must configure the sort order to ensure that the PowerCenter Server passes sorted data to
the Joiner transformation.
Configure the sort order using one of the following methods:
♦ Use sorted flat files. When the flat files contain sorted data, verify that the order of the
sort columns match in each source file.
♦ Use sorted relational data. Use sorted ports in the Source Qualifier transformation to sort
columns from the source database. Configure the order of the sorted ports the same in
each Source Qualifier transformation.
For more information about using sorted ports, see “Using Sorted Ports” on page 317.
♦ Use Sorter transformations. Use a Sorter transformation to sort relational or flat file data.
Place a Sorter transformation in the master and detail pipelines. Configure the order of the
sort key ports and the sort order direction the same in each Sorter transformation.
Using Sorted Input 163
For more information about using the Sorter transformation, see “Creating a Sorter
Transformation” on page 291.
If you pass unsorted or incorrectly sorted data to a Joiner transformation configured to use
sorted data, the session fails and the PowerCenter Server logs the error in the session log file.
Adding Transformations to the Mapping
When you add transformations between the sort origin and the Joiner transformation, use the
following guidelines to maintain sorted data:
♦ Do not place any of the following transformations between the sort origin and the Joiner
transformation:
− Custom
− Unsorted Aggregator
− Normalizer
− Rank
− Mapplet, if it contains one of the above transformations
♦ You can place a sorted Aggregator transformation between the sort origin and the Joiner
transformation if you use the following guidelines:
− Configure the Aggregator transformation for sorted input using the guidelines in “Using
Sorted Input” on page 9.
− Use the same ports for the group by columns in the Aggregator transformation as the
ports at the sort origin.
− The group by ports must be in the same order as the ports at the sort origin.
♦ When you join the result set of a Joiner transformation with another pipeline, verify that
the data output from the first Joiner transformation is sorted.
Note: Informatica recommends placing the Joiner transformation directly after the sort origin.
Configuring the Joiner Transformation
To configure the Joiner transformation to use sorted data, you must complete the following
tasks:
♦ Configure the transformation to use sorted data. Select Sorted Input on the Properties tab.
♦ Define the join condition to receive sorted data in the same order as the sort origin.
Defining the Join Condition
Configure the join condition to maintain the sort order established at the sort origin: the
sorted flat file, the Source Qualifier transformation, or the Sorter transformation. If you use a
sorted Aggregator transformation between the sort origin and the Joiner transformation, treat
164 Chapter 7: Joiner Transformation
the sorted Aggregator transformation as the sort origin when you define the join condition.
Use the following guidelines when you define join conditions:
♦ The ports you use in the join condition must match the ports at the sort origin.
♦ When you configure multiple join conditions, the ports in the first join condition must
match the first ports at the sort origin.
♦ When you configure multiple conditions, the order of the conditions must match the
order of the ports at the sort origin, and you must not skip any ports.
♦ The number of sorted ports in the sort origin can be greater than or equal to the number
of ports at the join condition.
Example of a Join Condition
For example, you configure Sorter transformations in the master and detail pipelines with the
following sorted ports:
1. ITEM_NO
2. ITEM NAME
3. PRICE
When you configure the join condition, use the following guidelines to maintain sort order:
♦ You must use ITEM_NO in the first join condition.
♦ If you add a second join condition, you must use ITEM_NAME.
♦ If you want to use PRICE in a join condition, you must also use ITEM_NAME in the
second join condition.
If you skip ITEM_NAME and join on ITEM_NO and PRICE, you lose the sort order and
the PowerCenter Server fails the session.
Using Sorted Input 165
Figure 7-3 shows a mapping configured to sort and join on the ports ITEM_NO,
ITEM_NAME, and PRICE:
Figure 7-3. A Mapping Configured to Join Data from Two Pipelines
The master and
detail Sorter
transformations
sort on the same
ports in the same
order.
When you use the Joiner transformation to join the master and detail pipelines, you can
configure any one of the following join conditions:
ITEM_NO = ITEM_NO
or
ITEM_NO = ITEM_NO1
ITEM_NAME = ITEM_NAME1
or
ITEM_NO = ITEM_NO1
ITEM_NAME = ITEM_NAME1
PRICE = PRICE1
166 Chapter 7: Joiner Transformation
Using Joiner Transformations in Mappings
When you use a Joiner transformation in a mapping, you must configure the mapping
according to the number of pipelines and sources you intend to use. You can configure a
mapping to join the following types of data:
♦ Data from multiple sources. When you want to join more than two pipelines, you must
configure the mapping using multiple Joiner transformations.
♦ Data from the same source. When you want to join data from the same source, you must
configure the mapping to use the same source.
Joining Data from Multiple Sources
You can join two sources with a Joiner transformation. To join more than two sources in a
mapping, add more Joiner transformations to the mapping.
Figure 7-4 shows the Joiner transformation joining multiple sources:
Figure 7-4. Joining the Result Set with a Second Joiner Transformation
Pipeline 1
Join pipelines 1
and 2.
Join the result set
Pipeline 2
with pipeline 3.
Pipeline 3
To join data from all three sources, first join Items and Items1 pipelines using the Joiner
transformation, Jnr_Sales_Price. You can then join the result set of Jnr_Sales_Price with the
Orders source using a second Joiner transformation named Jnr_Orders.
Joining Data from the Same Source
You may want to join data from the same source if you want to perform a calculation on part
of the data and join the transformed data with the original data. When you join the data using
this method, you can maintain the original data and transform parts of that data within one
mapping. You can join data from the same source in the following ways:
♦ Join two branches of the same pipeline.
♦ Create two instances of the same source and join pipelines from these source instances.
Using Joiner Transformations in Mappings 167
When you join data from the same source, you can create two branches of the pipeline. When
you branch a pipeline, you must add a transformation between the source qualifier and the
Joiner transformation in at least one branch of the pipeline. You must join sorted data and
configure the Joiner transformation for sorted input.
If you want to join unsorted data, you must create two instances of the same source and join
the pipelines.
For example, you have a source with the following ports:
♦ Employee
♦ Department
♦ Total Sales
In the target table, you want to view the employees who generated sales that were greater than
the average sales for their respective departments. To accomplish this, you create a mapping
with the following transformations:
♦ Sorter transformation. Sort the data.
♦ Sorted Aggregator transformation. Average the sales data and group by department.
When you perform this aggregation, you lose the data for individual employees. To
maintain employee data, you must pass a branch of the pipeline to the Aggregator
transformation and pass a branch with the same data to the Joiner transformation to
maintain the original data. When you join both branches of the pipeline, you join the
aggregated data with the original data.
♦ Sorted Joiner transformation. Use a sorted Joiner transformation to join the sorted
aggregated data with the original data.
♦ Filter transformation. Compare the average sales data against sales data for each employee
and filter out employees with less than above average sales.
Figure 7-5 illustrates joining two branches of the same pipeline:
Figure 7-5. Mapping that Joins Two Branches of a Pipeline
Pipeline Branch 1 Filter out employees with less than above
average sales.
Source Pipeline Branch 2 Sorted Joiner Transformation
Note: You can also join data from output groups of the same transformation, such as the
Custom transformation or XML Source Qualifier transformation. Place a Sorter
transformation between each output group and the Joiner transformation and configure the
Joiner transformation to receive sorted input.
168 Chapter 7: Joiner Transformation
Joining two branches might impact performance if the Joiner transformation receives data
from one branch much later than the other branch. The Joiner transformation caches all the
data from the first branch, and writes the cache to disk if the cache fills. The Joiner
transformation must then read the data from disk when it receives the data from the second
branch. This can slow processing.
You can also join same source data by creating a second instance of the source. After you
create the second source instance, you can join the pipelines from the two source instances.
Figure 7-6 shows two instances of the same source joined using a Joiner transformation:
Figure 7-6. Mapping that Joins Two Instances of the Same Source
Source
Instance 1
Source
Instance 2
Note: When you join data using this method, the PowerCenter Server reads the source data for
each source instance, so performance can be slower than joining two branches of a pipeline.
Use the following guidelines when deciding whether to join branches of a pipeline or join two
instances of a source:
♦ Join two branches of a pipeline when you have a large source or if you can read the source
data only once. For example, you can only read source data from a message queue once.
♦ Join two branches of a pipeline when you use sorted data. If the source data is unsorted
and you use a Sorter transformation to sort the data, branch the pipeline after you sort the
data.
♦ Join two instances of a source when you need to add a blocking transformation to the
pipeline between the source and the Joiner transformation.
♦ Join two instances of a source if one pipeline may process much more slowly than the other
pipeline.
Using Joiner Transformations in Mappings 169
PowerCenter Server Processing
A mapping with a Joiner transformation contains either two pipelines or two branches of a
pipeline. The two pipelines include a master pipeline and a detail pipeline or a master and a
detail branch.
Figure 7-7 illustrates the master and detail pipelines in a mapping with a Joiner
transformation:
Figure 7-7. Mapping with Master and Detail Pipelines
Master Pipeline
Detail Pipeline
When you run a session with a Joiner transformation, the PowerCenter Server reads the
sources in both pipelines and builds a cache to process the transformation. Also, the
PowerCenter Server might block and unblock the detail source to process the transformation,
depending on the mapping configuration and whether the Joiner transformation is configured
for sorted input.
When you partition a session using a Joiner transformation that requires sorted input, you
must verify the Joiner transformation receives sorted data. However, partitions that
redistribute rows can rearrange the order of sorted data, so it is important to configure
partitions to maintain sorted data. For more information about partitioning Joiner
transformations, see “Pipeline Partitioning” in the Workflow Administration Guide.
Caching
The number of rows the PowerCenter Server stores in the cache depends on the partitioning
scheme, the source data, and whether you configure the Joiner transformation for sorted
input.
When the PowerCenter Server processes a Joiner transformation, it reads rows from both
sources concurrently and builds the index and data cache based on the master rows. The
PowerCenter Server then performs the join based on the detail source data and the cache data.
To improve performance for an unsorted Joiner transformation, use the source with fewer
rows as the master source. To improve performance for a sorted Joiner transformation, use the
source with fewer duplicate key values as the master.
For more information about Joiner transformation caches, see “Session Caches” in the
Workflow Administration Guide.
170 Chapter 7: Joiner Transformation
Blocking the Source Pipelines
When you run a session with a Joiner transformation, the PowerCenter Server blocks and
unblocks the source data, based on the mapping configuration and whether you configure the
Joiner transformation for sorted input.
For more information about blocking source data, see “Understanding the Server
Architecture” in the Workflow Administration Guide.
Unsorted Joiner Transformation
When the PowerCenter Server processes an unsorted Joiner transformation, it reads all master
rows before it reads the detail rows. To ensure it reads all master rows before the detail rows,
the PowerCenter Server blocks the detail source while it caches rows from the master source.
Once the PowerCenter Server reads and caches all master rows, it unblocks the detail source
and reads the detail rows.
Some mappings with unsorted Joiner transformations violate data flow validation. For more
information about mappings that violate data flow validation, see “Mappings” in the Designer
Guide.
Sorted Joiner Transformation
When the PowerCenter Server processes a sorted Joiner transformation, it blocks data based
on the mapping configuration.
When the PowerCenter Server can block and unblock the source pipelines connected to the
Joiner transformation without blocking all sources in the target load order group
simultaneously, it uses blocking logic to process the Joiner transformation. Otherwise, it does
not use blocking logic and instead it stores more rows in the cache.
When the PowerCenter Server can use blocking logic to process the Joiner transformation, it
stores fewer rows in the cache, increasing performance. Blocking logic is possible if master and
detail input to the Joiner transformation originate from different sources.
PowerCenter Server Processing 171
Creating a Joiner Transformation
To use a Joiner transformation, add a Joiner transformation to the mapping, set up the input
sources, and configure the transformation with a condition and join type and sort type.
To create a Joiner Transformation:
1. In the Mapping Designer, choose Transformation-Create. Select the Joiner
transformation. Enter a name, click OK.
The naming convention for Joiner transformations is JNR_TransformationName. Enter a
description for the transformation.
The Designer creates the Joiner transformation. Keep in mind that you cannot use a
Sequence Generator or Update Strategy transformation as a source to a Joiner
transformation.
2. Drag all the desired input/output ports from the first source into the Joiner
transformation.
The Designer creates input/output ports for the source fields in the Joiner as detail fields
by default. You can edit this property later.
3. Select and drag all the desired input/output ports from the second source into the Joiner
transformation.
The Designer configures the second set of source fields and master fields by default.
4. Double-click the title bar of the Joiner transformation to open the Edit Transformations
dialog box.
172 Chapter 7: Joiner Transformation
5. Select the Ports tab.
6. Click any box in the M column to switch the master/detail relationship for the sources.
Tip: Use the source with fewer unique rows as the master source to increase join
performance.
7. Add default values for specific ports as necessary.
Certain ports are likely to contain null values, since the fields in one of the sources may
be empty. You can specify a default value if the target database does not handle NULLs.
Creating a Joiner Transformation 173
8. Select the Condition tab and set the join condition.
9. Click the Add button to add a condition. You can add multiple conditions. The master
and detail ports must have matching datatypes. The Joiner transformation only supports
equivalent (=) joins.
For more information about defining the join condition, see “Defining a Join Condition”
on page 159.
174 Chapter 7: Joiner Transformation
10. Select the Properties tab and configure properties for the transformation.
Note: The condition appears in the Join Condition row. You can edit this field from the
Condition tab. The keyword AND separates multiple conditions.
For more information about defining the properties, see “Joiner Transformation
Properties” on page 157.
11. Click OK.
12. Configure metadata extensions.
For information about working with metadata extensions, see “Metadata Extensions” in
the Repository Guide.
13. Choose Repository-Save to save changes to the mapping.
Creating a Joiner Transformation 175
Tips
The following tips can help improve session performance:
Perform joins in a database when possible.
Performing a join in a database is faster than performing a join in the session. In some cases,
this is not possible, such as joining tables from two different databases or flat file systems. If
you want to perform a join in a database, you can use the following options:
♦ Create a pre-session stored procedure to join the tables in a database.
♦ Use the Source Qualifier transformation to perform the join. For details, see “Joining
Source Data” on page 299 for more information.
Join sorted data when possible.
You can improve session performance by configuring the Joiner transformation to use sorted
input. When you configure the Joiner transformation to use sorted data, the PowerCenter
Server improves performance by minimizing disk input and output. You see the greatest
performance improvement when you work with large data sets. For details, see “Using Sorted
Input” on page 163.
For an unsorted Joiner transformation, designate as the master source the source with fewer
rows.
For optimal performance and disk storage, designate the master source as the source with the
fewer rows. During a session, the Joiner transformation compares each row of the master
source against the detail source. The fewer unique rows in the master, the fewer iterations of
the join comparison occur, which speeds the join process.
For a sorted Joiner transformation, designate as the master source the source with fewer
duplicate key values.
For optimal performance and disk storage, designate the master source as the source with
fewer duplicate key values. When the PowerCenter Server processes a sorted Joiner
transformation, it caches rows for one hundred keys at a time. If the master source contains
many rows with the same key value, the PowerCenter Server must cache more rows, and
performance can be slowed.
176 Chapter 7: Joiner Transformation
Chapter 8
Lookup Transformation
This chapter includes the following topics:
♦ Overview, 178
♦ Connected and Unconnected Lookups, 179
♦ Relational and Flat File Lookups, 181
♦ Lookup Components, 183
♦ Lookup Properties, 186
♦ Lookup Query, 193
♦ Lookup Condition, 197
♦ Lookup Caches, 199
♦ Configuring Unconnected Lookup Transformations, 200
♦ Creating a Lookup Transformation, 204
♦ Tips, 205
177
Overview
Transformation type:
Passive
Connected/Unconnected
Use a Lookup transformation in a mapping to look up data in a flat file or a relational table,
view, or synonym. You can import a lookup definition from any flat file or relational database
to which both the PowerCenter Client and Server can connect. You can use multiple Lookup
transformations in a mapping.
The PowerCenter Server queries the lookup source based on the lookup ports in the
transformation. It compares Lookup transformation port values to lookup source column
values based on the lookup condition. Pass the result of the lookup to other transformations
and a target.
You can use the Lookup transformation to perform many tasks, including:
♦ Get a related value. For example, your source includes employee ID, but you want to
include the employee name in your target table to make your summary data easier to read.
♦ Perform a calculation. Many normalized tables include values used in a calculation, such
as gross sales per invoice or sales tax, but not the calculated value (such as net sales).
♦ Update slowly changing dimension tables. You can use a Lookup transformation to
determine whether rows already exist in the target.
You can configure the Lookup transformation to perform the following types of lookups:
♦ Connected or unconnected. Connected and unconnected transformations receive input
and send output in different ways.
♦ Relational or flat file lookup. When you create a Lookup transformation, you can choose
to perform a lookup on a flat file or a relational table.
When you create a Lookup transformation using a relational table as the lookup source,
you can connect to the lookup source using ODBC and import the table definition as the
structure for the Lookup transformation.
When you create a Lookup transformation using a flat file as a lookup source, the Designer
invokes the Flat File Wizard. For more information about using the Flat File Wizard, see
“Working with Flat Files” in the Designer Guide.
♦ Cached or uncached. Sometimes you can improve session performance by caching the
lookup table. If you cache the lookup, you can choose to use a dynamic or static cache. By
default, the lookup cache remains static and does not change during the session. With a
dynamic cache, the PowerCenter Server inserts or updates rows in the cache during the
session. When you cache the target table as the lookup, you can look up values in the
target and insert them if they do not exist, or update them if they do.
Note: If you use a flat file lookup, you must use a static cache.
See the Informatica Webzine for case studies and more information about lookups. You can
access the webzine at http://my.informatica.com.
178 Chapter 8: Lookup Transformation
Connected and Unconnected Lookups
You can configure a connected Lookup transformation to receive input directly from the
mapping pipeline, or you can configure an unconnected Lookup transformation to receive
input from the result of an expression in another transformation.
Table 8-1 lists the differences between connected and unconnected lookups:
Table 8-1. Differences Between Connected and Unconnected Lookups
Connected Lookup Unconnected Lookup
Receives input values directly from the pipeline. Receives input values from the result of a :LKP expression
in another transformation.
You can use a dynamic or static cache. You can use a static cache.
Cache includes all lookup columns used in the mapping Cache includes all lookup/output ports in the lookup
(that is, lookup source columns included in the lookup condition and the lookup/return port.
condition and lookup source columns linked as output
ports to other transformations).
Can return multiple columns from the same row or insert Designate one return port (R). Returns one column from
into the dynamic lookup cache. each row.
If there is no match for the lookup condition, the If there is no match for the lookup condition, the
PowerCenter Server returns the default value for all PowerCenter Server returns NULL.
output ports. If you configure dynamic caching, the
PowerCenter Server inserts rows into the cache or
leaves it unchanged.
If there is a match for the lookup condition, the If there is a match for the lookup condition, the PowerCenter
PowerCenter Server returns the result of the lookup Server returns the result of the lookup condition into the
condition for all lookup/output ports. If you configure return port.
dynamic caching, the PowerCenter Server either
updates the row the in the cache or leaves the row
unchanged.
Pass multiple output values to another transformation. Pass one output value to another transformation. The
Link lookup/output ports to another transformation. lookup/output/return port passes the value to the
transformation calling :LKP expression.
Supports user-defined default values. Does not support user-defined default values.
Connected Lookup Transformation
The following steps describe how the PowerCenter Server processes a connected Lookup
transformation:
1. A connected Lookup transformation receives input values directly from another
transformation in the pipeline.
2. For each input row, the PowerCenter Server queries the lookup source or cache based on
the lookup ports and the condition in the transformation.
Connected and Unconnected Lookups 179
3. If the transformation is uncached or uses a static cache, the PowerCenter Server returns
values from the lookup query.
If the transformation uses a dynamic cache, the PowerCenter Server inserts the row into
the cache when it does not find the row in the cache. When the PowerCenter Server finds
the row in the cache, it updates the row in the cache or leaves it unchanged. It flags the
row as insert, update, or no change.
4. The PowerCenter Server passes return values from the query to the next transformation.
If the transformation uses a dynamic cache, you can pass rows to a Filter or Router
transformation to filter new rows to the target.
Note: This chapter discusses connected Lookup transformations unless otherwise specified.
Unconnected Lookup Transformation
An unconnected Lookup transformation receives input values from the result of a :LKP
expression in another transformation. You can call the Lookup transformation more than
once in a mapping.
A common use for unconnected Lookup transformations is to update slowly changing
dimension tables. For more information about slowly changing dimension tables, see the
Informatica Webzine at http://my.informatica.com.
The following steps describe the way the PowerCenter Server processes an unconnected
Lookup transformation:
1. An unconnected Lookup transformation receives input values from the result of a :LKP
expression in another transformation, such as an Update Strategy transformation.
2. The PowerCenter Server queries the lookup source or cache based on the lookup ports
and condition in the transformation.
3. The PowerCenter Server returns one value into the return port of the Lookup
transformation.
4. The Lookup transformation passes the return value into the :LKP expression.
For more information about unconnected Lookup transformations, see “Configuring
Unconnected Lookup Transformations” on page 200.
180 Chapter 8: Lookup Transformation
Relational and Flat File Lookups
When you create a Lookup transformation, you can choose to use a relational table or a flat
file for the lookup source.
Relational Lookups
When you create a Lookup transformation using a relational table as a lookup source, you can
connect to the lookup source using ODBC and import the table definition as the structure for
the Lookup transformation.
You can use the following options with relational lookups only:
♦ You can override the default SQL statement if you want to add a WHERE clause or query
multiple tables.
♦ You can use a dynamic lookup cache with relational lookups.
Flat File Lookups
When you use a flat file for a lookup source, you can use any flat file definition in the
repository, or you can import it. When you import a flat file lookup source, the Designer
invokes the Flat File Wizard.
You can use the following options with flat file lookups only:
♦ You can use indirect files as lookup sources by specifying a file list as the lookup file name.
♦ You can use sorted input for the lookup.
♦ You can sort null data high or low. With relational lookups, this is based on the database
support.
♦ You can use case-sensitive string comparison with flat file lookups. With relational
lookups, the case-sensitive comparison is based on the database support.
Using Sorted Input
When you configure a flat file Lookup transformation for sorted input, the condition
columns must be grouped. If the condition columns are not grouped, the PowerCenter Server
cannot cache the lookup and fails the session. For best caching performance, sort the
condition columns.
For example, a Lookup transformation has the following condition:
OrderID = OrderID1
CustID = CustID1
Relational and Flat File Lookups 181
In the following flat file lookup source, the keys are grouped, but not sorted. The
PowerCenter Server can cache the data, but performance may not be optimal.
OrderID CustID ItemNo. ItemDesc Comments
1001 CA502 F895S Flashlight Key data is grouped, but not sorted.
CustID is out of order within OrderID.
1001 CA501 C530S Compass
1001 CA501 T552T Tent
1005 OK503 S104E Safety Knife Key data is grouped, but not sorted.
OrderID is out of order.
1003 CA500 F304T First Aid Kit
1003 TN601 R938M Regulator System
In the following flat file lookup source, the keys are not grouped. The PowerCenter Server
cannot cache the data and fails the session.
OrderID CustID ItemNo. ItemDesc Comments
1001 CA501 T552T Tent
1001 CA501 C530S Compass
1005 OK503 S104E Safety Knife
1003 TN601 R938M Regulator System
1003 CA500 F304T First Aid Kit
1001 CA502 F895S Flashlight Key data for CustID is not grouped.
If you choose sorted input for indirect files, the range of data must not overlap in the files.
182 Chapter 8: Lookup Transformation
Lookup Components
Define the following components when you configure a Lookup transformation in a
mapping:
♦ Lookup source
♦ Ports
♦ Properties
♦ Condition
♦ Metadata extensions
Lookup Source
You can use a flat file or a relational table for a lookup source. When you create a Lookup
transformation, you can import the lookup source from the following locations:
♦ Any relational source or target definition in the repository
♦ Any flat file source or target definition in the repository
♦ Any table or file that both the PowerCenter Server and Client machine can connect to
The lookup table can be a single table, or you can join multiple tables in the same database
using a lookup SQL override. The PowerCenter Server queries the lookup table or an in-
memory cache of the table for all incoming rows into the Lookup transformation.
The PowerCenter Sever can connect to a lookup table using a native database driver or an
ODBC driver. However, the native database drivers improve session performance.
Indexes and a Lookup Table
If you have privileges to modify the database containing a lookup table, you can improve
lookup initialization time by adding an index to the lookup table. This is important for very
large lookup tables. Since the PowerCenter Server needs to query, sort, and compare values in
these columns, the index needs to include every column used in a lookup condition.
You can improve performance by indexing the following types of lookup:
♦ Cached lookups. You can improve performance by indexing the columns in the lookup
ORDER BY. The session log contains the ORDER BY statement.
♦ Uncached lookups. Because the PowerCenter Server issues a SELECT statement for each
row passing into the Lookup transformation, you can improve performance by indexing
the columns in the lookup condition.
Lookup Ports
The Ports tab contains options similar to other transformations, such as port name, datatype,
and scale. In addition to input and output ports, the Lookup transformation includes a
Lookup Components 183
lookup port type that represents columns of data in the lookup source. An unconnected
Lookup transformation also includes a return port type that represents the return value.
Table 8-2 describes the port types in a Lookup transformation:
Table 8-2. Lookup Transformation Port Types
Type of Number
Ports Description
Lookup Required
I Connected Minimum of 1 Input port. Create an input port for each lookup port you want to
Unconnected use in the lookup condition. You must have at least one input or
input/output port in each Lookup transformation.
O Connected Minimum of 1 Output port. Create an output port for each lookup port you want
Unconnected to link to another transformation. You can designate both input
and lookup ports as output ports. For connected lookups, you
must have at least one output port. For unconnected lookups,
use a lookup/output port as a return port (R) to designate a
return value.
L Connected Minimum of 1 Lookup port. The Designer automatically designates each
Unconnected column in the lookup source as a lookup (L) and output port (O).
R Unconnected 1 only Return port. Use only in unconnected Lookup transformations.
Designates the column of data you want to return based on the
lookup condition. You can designate one lookup/output port as
the return port.
The Lookup transformation also enables an associated ports property that you configure when
you use a dynamic cache.
Use the following guidelines to configure lookup ports:
♦ If you delete lookup ports from a flat file session, the session fails.
♦ You can delete lookup ports from a relational lookup if you are certain the mapping does
not use the lookup port. This reduces the amount of memory the PowerCenter Server uses
to run the session.
♦ To ensure datatypes match when you add an input port, copy the existing lookup ports.
Lookup Properties
On the Properties tab, you can configure properties, such as an SQL override for relational
lookups, the lookup source name, and tracing level for the transformation. You can also
configure caching properties on the Properties tab.
For more information about lookup properties, see “Lookup Properties” on page 186.
184 Chapter 8: Lookup Transformation
Lookup Condition
On the Condition tab, you can enter the condition or conditions you want the PowerCenter
Server to use to determine whether input data qualifies values in the lookup source or cache.
For more information about the lookup condition, see “Lookup Condition” on page 197.
Metadata Extensions
You can extend the metadata stored in the repository by associating information with
repository objects, such as Lookup transformations. For example, when you create a Lookup
transformation, you may want to store your name and the creation date with the Lookup
transformation. You associate information with repository metadata using metadata
extensions. For more information, see “Metadata Extensions” in the Repository Guide.
Lookup Components 185
Lookup Properties
Properties for the Lookup transformation identify the database source, how the PowerCenter
Server processes the transformation, and how it handles caching and multiple matches.
When you create a mapping, you specify the properties for each Lookup transformation.
When you create a session, you can override some properties, such as the index and data cache
size, for each transformation in the session properties.
Table 8-3 describes the Lookup transformation properties:
Table 8-3. Lookup Transformation Properties
Lookup
Option Description
Type
Lookup SQL Override Relational Overrides the default SQL statement to query the lookup table.
Specifies the SQL statement you want the PowerCenter Server to use for
querying lookup values. Use only with the lookup cache enabled.
For more information, see “Lookup Query” on page 193.
Lookup Table Name Relational Specifies the name of the table from which the transformation looks up
and caches values. You can import a table, view, or synonym from
another database by selecting the Import button on the dialog box that
displays when you first create a Lookup transformation.
If you enter a lookup SQL override, you do not need to add an entry for
this option.
Lookup Caching Enabled Flat File, Indicates whether the PowerCenter Server caches lookup values during
Relational the session.
When you enable lookup caching, the PowerCenter Server queries the
lookup source once, caches the values, and looks up values in the cache
during the session. This can improve session performance.
When you disable caching, each time a row passes into the
transformation, the PowerCenter Server issues a select statement to the
lookup source for lookup values.
Note: The PowerCenter Server always caches flat file lookups.
Lookup Policy on Multiple Flat File, Determines what happens when the Lookup transformation finds multiple
Match Relational rows that match the lookup condition. You can select the first or last row
returned from the cache or lookup source, or report an error.
Lookup Condition Flat File, Displays the lookup condition you set in the Condition tab.
Relational
186 Chapter 8: Lookup Transformation
Table 8-3. Lookup Transformation Properties
Lookup
Option Description
Type
Connection Information Relational Specifies the database containing the lookup table. You can select the
exact database connection or you can use the $Source or $Target
variable. If you use one of these variables, the lookup table must reside
in the source or target database you specify when you configure the
session.
If you select the exact database connection, you can also specify what
type of database connection it is. Type Application: before the
connection name if it is an Application connection. Type Relational:
before the connection name if it is a relational connection.
If you do not specify the type of database connection, the PowerCenter
Server fails the session if it cannot determine the type of database
connection.
For more information about using $Source and $Target, see “Configuring
Relational Lookups in a Session” on page 191.
Source Type Flat File, Indicates that the Lookup transformation reads values from a relational
Relational database or a flat file.
Tracing Level Flat File, Sets the amount of detail included in the session log when you run a
Relational session containing this transformation.
Lookup Cache Directory Flat File, Specifies the directory used to build the lookup cache files when you
Name Relational configure the Lookup transformation to cache the lookup source. Also
used to save the persistent lookup cache files when you select the
Lookup Persistent option.
By default, the PowerCenter Server uses the $PMCacheDir directory
configured for the PowerCenter Server.
Lookup Cache Persistent Flat File, Indicates whether the PowerCenter Server uses a persistent lookup
Relational cache, which consists of at least two cache files. If a Lookup
transformation is configured for a persistent lookup cache and persistent
lookup cache files do not exist, the PowerCenter Server creates the files
during the session. Use only with the lookup cache enabled.
Lookup Data Cache Size Flat File, Indicates the maximum size the PowerCenter Server allocates to the
Relational data cache in memory. If the PowerCenter Server cannot allocate the
configured amount of memory when initializing the session, it fails the
session. When the PowerCenter Server cannot store all the data cache
data in memory, it pages to disk as necessary.
The Lookup Data Cache Size is 2,000,000 bytes by default. The
minimum size is 1,024 bytes. If the total configured session cache size is
2 GB (2,147,483, 648 bytes) or greater, you must run the session on a
64-bit PowerCenter Server.
Use only with the lookup cache enabled.
Lookup Properties 187
Table 8-3. Lookup Transformation Properties
Lookup
Option Description
Type
Lookup Index Cache Size Flat File, Indicates the maximum size the PowerCenter Server allocates to the
Relational index cache in memory. If the PowerCenter Server cannot allocate the
configured amount of memory when initializing the session, it fails the
session. When the PowerCenter Server cannot store all the index cache
data in memory, it pages to disk as necessary.
The Lookup Index Cache Size is 1,000,000 bytes by default. The
minimum size is 1,024 bytes. If the total configured session cache size is
2 GB (2,147,483, 648 bytes) or greater, you must run the session on a
64-bit PowerCenter Server.
Use only with the lookup cache enabled.
Dynamic Lookup Cache Relational Indicates to use a dynamic lookup cache. Inserts or updates rows in the
lookup cache as it passes rows to the target table.
Use only with the lookup cache enabled.
Output Old Value On Relational Use only with dynamic caching enabled. When you enable this property,
Update the PowerCenter Server outputs old values out of the lookup/output
ports. When the PowerCenter Server updates a row in the cache, it
outputs the value that existed in the lookup cache before it updated the
row based on the input data. When the PowerCenter Server inserts a
new row in the cache, it outputs null values.
When you disable this property, the PowerCenter Server outputs the
same values out of the lookup/output and input/output ports.
This property is enabled by default.
Cache File Name Prefix Flat File, Use only with persistent lookup cache. Specifies the file name prefix to
Relational use with persistent lookup cache files. The PowerCenter Server uses the
file name prefix as the file name for the persistent cache files it saves to
disk. Only enter the prefix. Do not enter .idx or .dat.
If the named persistent cache files exist, the PowerCenter Server builds
the memory cache from the files. If the named persistent cache files do
not exist, the PowerCenter Server rebuilds the persistent cache files.
Recache From Lookup Flat File, Use only with the lookup cache enabled. When selected, the
Source Relational PowerCenter Server rebuilds the lookup cache from the lookup source
when it first calls the Lookup transformation instance.
If you use a persistent lookup cache, it rebuilds the persistent cache files
before using the cache. If you do not use a persistent lookup cache, it
rebuilds the lookup cache in memory before using the cache.
Insert Else Update Relational Use only with dynamic caching enabled. Applies to rows entering the
Lookup transformation with the row type of insert. When you select this
property and the row type entering the Lookup transformation is insert,
the PowerCenter Server inserts the row into the cache if it is new, and
updates the row if it exists. If you do not select this property, the
PowerCenter Server only inserts new rows into the cache when the row
type entering the Lookup transformation is insert. For more information
about defining the row type, see “Using Update Strategy Transformations
with a Dynamic Cache” on page 222.
188 Chapter 8: Lookup Transformation
Table 8-3. Lookup Transformation Properties
Lookup
Option Description
Type
Update Else Insert Relational Use only with dynamic caching enabled. Applies to rows entering the
Lookup transformation with the row type of update. When you select this
property and the row type entering the Lookup transformation is update,
the PowerCenter Server updates the row in the cache if it exists, and
inserts the row if it is new. If you do not select this property, the
PowerCenter Server only updates existing rows in the cache when the
row type entering the Lookup transformation is update.
For more information about defining the row type, see “Using Update
Strategy Transformations with a Dynamic Cache” on page 222.
Datetime Format Flat File If you do not define a datetime format for a particular field in the lookup
definition or on the Ports tab, the PowerCenter Server uses the
properties defined here.
You can enter any datetime format. The default is MM/DD/YYYY
HH24:MI:SS.
Thousand Separator Flat File If you do not define a thousand separator for a particular field in the
lookup definition or on the Ports tab, the PowerCenter Server uses the
properties defined here.
You can choose no separator, a comma, or a period. The default is no
separator.
Decimal Separator Flat File If you do not define a decimal separator for a particular field in the lookup
definition or on the Ports tab, the PowerCenter Server uses the
properties defined here.
You can choose a comma or a period decimal separator. The default is
period.
Case-Sensitive String Flat File If selected, the PowerCenter Server uses case-sensitive string
Comparison comparisons when performing lookups on string columns.
Note: For relational lookups, the case-sensitive comparison is based on
the database support.
Null Ordering Flat File Determines how the PowerCenter Server orders null values. You can
choose to sort null values high or low. By default, the PowerCenter
Server sorts null values high. This overrides the PowerCenter Server
configuration to treat nulls in comparison operators as high, low, or null.
Note: For relational lookups, null ordering is based on the database
support.
Sorted Input Flat File Indicates whether or not the lookup file data is sorted. This increases
lookup performance for file lookups. If you enable sorted input, and the
condition columns are not grouped, the PowerCenter Server fails the
session. If the condition columns are grouped, but not sorted, the
PowerCenter Server processes the lookup as if you did not configure
sorted input. For more information about sorted input, see “Flat File
Lookups” on page 181.
Configuring Lookup Properties in a Session
When you configure a session, you can configure lookup properties that are unique to
sessions:
Lookup Properties 189
♦ Flat file lookups. Configure location information, such as the file directory, file name, and
the file type.
♦ Relational lookups. You can define $Source and $Target variables in the session
properties. You can also override connection information to use the server variable
$DBConnection.
Configuring Flat File Lookups in a Session
Figure 8-1 shows the session properties for a flat file lookup:
Figure 8-1. Session Properties for Flat File Lookups
Session
Properties for
Flat File Lookup
190 Chapter 8: Lookup Transformation
Table 8-4 describes the session properties you configure for flat file lookups:
Table 8-4. Session Properties for Flat File Lookups
Property Description
Lookup Source File Directory Enter the directory name. By default, the PowerCenter Server looks in the
server variable directory, $PMLookupFileDir, for lookup files.
You can enter the full path and file name. If you specify both the directory
and file name in the Lookup Source Filename field, clear this field. The
PowerCenter Server concatenates this field with the Lookup Source
Filename field when it runs the session.
You can also use the $InputFileName session parameter to specify the
file name.
For more information about session parameters, see “Session
Parameters” in the Workflow Administration Guide.
Lookup Source Filename The name of the lookup file. If you use an indirect file, specify the name of
the indirect file you want the PowerCenter Server to read.
You can also use the lookup file parameter, $LookupFileName, to change
the name of the lookup file a session uses.
If you specify both the directory and file name in the Source File Directory
field, clear this field. The PowerCenter Server concatenates this field with
the Lookup Source File Directory field when it runs the session. For
example, if you have “C:\lookup_data\” in the Lookup Source File
Directory field, then enter “filename.txt” in the Lookup Source Filename
field. When the PowerCenter Server begins the session, it looks for
“C:\lookup_data\filename.txt”.
For more information, see “Session Parameters” in the Workflow
Administration Guide.
Lookup Source Filetype Indicates whether the lookup source file contains the source data or a list
of files with the same file properties. Choose Direct if the lookup source
file contains the source data. Choose Indirect if the lookup source file
contains a list of files.
When you select Indirect, the PowerCenter Server creates one cache for
all files. If you use sorted input with indirect files, verify that the range of
data in the files do not overlap. If the range of data overlaps, the
PowerCenter Server processes the lookup as if you did not configure for
sorted input.
Configuring Relational Lookups in a Session
When you configure a session, you specify the connection for the lookup database in the
Connection node on the Mapping tab (Transformation view). You have the following options
to specify a connection:
♦ Choose any relational connection.
♦ Use the connection variable, $DBConnection.
♦ Specify a database connection for $Source or $Target information.
If you use $Source or $Target for the lookup connection, configure the $Source Connection
Value and $Target Connection Value in the session properties. This ensures that the
Lookup Properties 191
PowerCenter Server uses the correct database connection for the variable when it runs the
session.
If you use $Source or $Target and you do not specify a Connection Value in the session
properties, the PowerCenter Server determines the database connection to use when it runs
the session. It uses a source or target database connection for the source or target in the
pipeline that contains the Lookup transformation. If it cannot determine which database
connection to use, it fails the session.
The following list describes how the PowerCenter Server determines the value of $Source or
$Target when you do not specify $Source Connection Value or $Target Connection Value in
the session properties:
♦ When you use $Source and the pipeline contains one source, the PowerCenter Server uses
the database connection you specify for the source.
♦ When you use $Source and the pipeline contains multiple sources joined by a Joiner
transformation, the PowerCenter Server uses different database connections, depending on
the location of the Lookup transformation in the pipeline:
− When the Lookup transformation is after the Joiner transformation, the PowerCenter
Server uses the database connection for the detail table.
− When the Lookup transformation is before the Joiner transformation, the PowerCenter
Server uses the database connection for the source connected to the Lookup
transformation.
♦ When you use $Target and the pipeline contains one target, the PowerCenter Server uses
the database connection you specify for the target.
♦ When you use $Target and the pipeline contains multiple relational targets, the session
fails.
♦ When you use $Source or $Target in an unconnected Lookup transformation, the session
fails.
192 Chapter 8: Lookup Transformation
Lookup Query
The PowerCenter Server queries the lookup based on the ports and properties you configure
in the Lookup transformation. The PowerCenter Server runs a default SQL statement when
the first row enters the Lookup transformation. If you use a relational lookup, you can
customize the default query with the Lookup SQL Override property.
Default Lookup Query
The default lookup query contains the following statements:
♦ SELECT. The SELECT statement includes all the lookup ports in the mapping. You can
view the SELECT statement by generating SQL using the Lookup SQL Override property.
Do not add or delete any columns from the default SQL statement.
♦ ORDER BY. The ORDER BY statement orders the columns in the same order they
appear in the Lookup transformation. The PowerCenter Server generates the ORDER BY
statement. You cannot view this when you generate the default SQL using the Lookup
SQL Override property.
Overriding the Lookup Query
The lookup SQL override is similar to entering a custom query in a Source Qualifier
transformation. You can override the lookup query for a relational lookup. You can enter the
entire override, or you can generate and edit the default SQL statement. When the Designer
generates the default SQL statement for the lookup SQL override, it includes the lookup/
output ports in the lookup condition and the lookup/return port.
Override the lookup query in the following circumstances:
♦ Override the ORDER BY statement. Create ORDER BY statement with fewer columns
to increase performance. When you override the ORDER BY statement, you must
suppress the generated ORDER BY statement with a comment notation. For more
information, see “Overriding the ORDER BY Statement” on page 194.
♦ A lookup table name or column names contains a reserved word. If the table name or any
column name in the lookup query contains a reserved word, you must ensure that all
reserved words are enclosed in quotes. For more information, see “Reserved Words” on
page 195.
♦ Use mapping parameters and variables. You can use mapping parameters and variables
when you enter a lookup SQL override. However, the Designer cannot expand mapping
parameters and variables in the query override and does not validate the lookup SQL
override. When you run a session with a mapping parameter or variable in the lookup SQL
override, the PowerCenter Server expands mapping parameters and variables and connects
to the lookup database to validate the query override. For more information about using
mapping parameters and variables in expressions, see “Mapping Parameters and Variables”
in the Designer Guide.
Lookup Query 193
♦ A lookup column name contains a slash (/) character. When generating the default
lookup query, the Designer and PowerCenter Server replace any slash character (/) in the
lookup column name with an underscore character. To query lookup column names
containing the slash character, override the default lookup query, replace the underscore
characters with the slash character, and enclose the column name in double quotes.
♦ Add a WHERE statement. Use a lookup SQL override to add a WHERE statement to the
default SQL statement. You might want to use this to reduce the number of rows included
in the cache. When you add a WHERE statement to a Lookup transformation using a
dynamic cache, use a Filter transformation before the Lookup transformation. This
ensures the PowerCenter Server only inserts rows into the dynamic cache and target table
that match the WHERE clause. For more information, see “Using the WHERE Clause
with a Dynamic Cache” on page 226.
Note: The the session fails if you include large object ports in a WHERE clause.
♦ Other. Use a lookup SQL override if you want to query lookup data from multiple
lookups or if you want to modify the data queried from the lookup table before the
PowerCenter Server caches the lookup rows. For example, you can use TO_CHAR to
convert dates to strings.
Overriding the ORDER BY Statement
By default, the PowerCenter Server generates an ORDER BY statement for a cached lookup.
The ORDER BY statement contains all lookup ports. To increase performance, you can
suppress the default ORDER BY statement and enter an override ORDER BY with fewer
columns.
The PowerCenter Server always generates an ORDER BY statement, even if you enter one in
the override. Place two dashes ‘--’ after the ORDER BY override to suppress the generated
ORDER BY statement. For example, a Lookup transformation uses the following lookup
condition:
ITEM_ID = IN_ITEM_ID
PRICE <= IN_PRICE
The Lookup transformation includes three lookup ports used in the mapping, ITEM_ID,
ITEM_NAME, and PRICE. When you enter the ORDER BY statement, enter the columns
in the same order as the ports in the lookup condition. You must also enclose all database
reserved words in quotes. Enter the following lookup query in the lookup SQL override:
SELECT ITEMS_DIM.ITEM_NAME, ITEMS_DIM.PRICE, ITEMS_DIM.ITEM_ID FROM
ITEMS_DIM ORDER BY ITEMS_DIM.ITEM_ID, ITEMS_DIM.PRICE --
To override the default ORDER BY statement for a relational lookup, complete the following
steps:
1. Generate the lookup query in the Lookup transformation.
2. Enter an ORDER BY statement that contains the condition ports in the same order they
appear in the Lookup condition.
3. Place two dashes ‘--’ as a comment notation after the ORDER BY statement to suppress
the ORDER BY statement that the PowerCenter Server generates.
194 Chapter 8: Lookup Transformation
If you override the lookup query with an ORDER BY statement without adding
comment notation, the lookup fails.
Note: Sybase has a 16 column ORDER BY limitation. If the Lookup transformation has more
than 16 lookup/output ports (including the ports in the lookup condition), you might want
to override the ORDER BY statement or use multiple Lookup transformations to query the
lookup table.
Reserved Words
If any lookup name or column name contains a database reserved word, such as MONTH or
YEAR, the session fails with database errors when the PowerCenter Server executes SQL
against the database. You can create and maintain a reserved words file, reswords.txt, in the
PowerCenter Server installation directory. When the PowerCenter Server initializes a session,
it searches for reswords.txt. If the file exists, the PowerCenter Server places quotes around
matching reserved words when it executes SQL against the database.
You may need to enable some databases, such as Microsoft SQL Server and Sybase, to use
SQL-92 standards regarding quoted identifiers. You can use environment SQL to issue the
command. For example, with Microsoft SQL Server, you can use the following command:
SET QUOTED_IDENTIFIER ON
Note: The reserved words file, reswords.txt, is a file that you create and maintain in the
PowerCenter Server installation directory. The PowerCenter Server searches this file and
places quotes around reserved words when it executes SQL against source, target, and lookup
databases. For more information about reswords.txt, see “Working with Targets” in the
Workflow Administration Guide.
Guidelines to Overriding the Lookup Query
Use the following guidelines when you override the lookup SQL query:
♦ You can only override the lookup SQL query for relational lookups.
♦ Configure the Lookup transformation for caching. If you do not enable caching, the
PowerCenter Server does not recognize the override.
♦ Generate the default query, and then configure the override. This helps ensure that all the
lookup/output ports are included in the query. If you add or subtract ports from the
SELECT statement, the session fails.
♦ Use a Filter transformation before a Lookup transformation using a dynamic cache when
you add a WHERE clause to the lookup SQL override. This ensures the PowerCenter
Server only inserts rows in the dynamic cache and target table that match the WHERE
clause. For more information, see “Using the WHERE Clause with a Dynamic Cache” on
page 226.
♦ If you want to share the cache, use the same lookup SQL override for each Lookup
transformation.
♦ If you override the ORDER BY statement, the session fails if the ORDER BY statement
does not contain the condition ports in the same order they appear in the Lookup
Lookup Query 195
condition or if you do not suppress the generated ORDER BY statement with the
comment notation.
♦ If the table name or any column name in the lookup query contains a reserved word, you
must enclose all reserved words in quotes.
Steps to Overriding the Lookup Query
Use the following steps to override the default lookup SQL query.
To override the default lookup query:
1. On the Properties tab, open the SQL Editor from within the Lookup SQL Override field.
2. Click Generate SQL to generate the default SELECT statement. Enter the lookup SQL
override.
3. Connect to a database, and then click Validate to test the lookup SQL override.
4. Click OK to return to the Properties tab.
196 Chapter 8: Lookup Transformation
Lookup Condition
The PowerCenter Server uses the lookup condition to test incoming values. It is similar to the
WHERE clause in an SQL query. When you configure a lookup condition for the
transformation, you compare transformation input values with values in the lookup source or
cache, represented by lookup ports. When you run a workflow, the PowerCenter Server
queries the lookup source or cache for all incoming values based on the condition.
You must enter a lookup condition in all Lookup transformations. Some guidelines for the
lookup condition apply for all Lookup transformations, and some guidelines vary depending
on how you configure the transformation.
Use the following guidelines when you enter a condition for a Lookup transformation:
♦ The datatypes in a condition must match.
♦ Use one input port for each lookup port used in the condition. You can use the same input
port in more than one condition in a transformation.
♦ When you enter multiple conditions, the PowerCenter Server evaluates each condition as
an AND, not an OR. The PowerCenter Server returns only rows that match all the
conditions you specify.
♦ The PowerCenter Server matches null values. For example, if an input lookup condition
column is NULL, the PowerCenter Server evaluates the NULL equal to a NULL in the
lookup.
♦ If you configure a flat file lookup for sorted input, the PowerCenter Server fails the session
if the condition columns are not grouped. If the columns are grouped, but not sorted, the
PowerCenter Server processes the lookup as if you did not configure sorted input. For
more information about sorted input, see “Flat File Lookups” on page 181.
The lookup condition guidelines and the way the PowerCenter Server processes matches can
vary, depending on whether you configure the transformation for a dynamic cache or an
uncached or static cache. For more information about lookup caches, see “Lookup Caches” on
page 207.
Uncached or Static Cache
Use the following guidelines when you configure a Lookup transformation without a cache or
to use a static cache:
♦ You can use the following operators when you create the lookup condition:
=, >, <, >=, <=, !=
Tip: If you include more than one lookup condition, place the conditions with an equal
sign first to optimize lookup performance. For example, create the following lookup
condition:
ITEM_ID = IN_ITEM_ID
PRICE <= IN_PRICE
♦ The input value must meet all conditions for the lookup to return a value.
Lookup Condition 197
The condition can match equivalent values or supply a threshold condition. For example, you
might look for customers who do not live in California, or employees whose salary is greater
than $30,000. Depending on the nature of the source and condition, the lookup might return
multiple values.
Handling Multiple Matches
Lookups find a value based on the conditions you set in the Lookup transformation. If the
lookup condition is not based on a unique key, or if the lookup source is denormalized, the
PowerCenter Server might find multiple matches in the lookup source or cache.
You can configure the static Lookup transformation to handle multiple matches in the
following ways:
♦ Return the first matching value, or return the last matching value. You can configure the
transformation either to return the first matching value or the last matching value. The
first and last values are the first values and last values found in the lookup cache that match
the lookup condition. When you cache the lookup source, the PowerCenter Server
determines which row is first and which is last by generating an ORDER BY clause for
each column in the lookup cache. The PowerCenter Server then sorts each lookup source
column in the lookup condition in ascending order.
The PowerCenter Server sorts numeric columns in ascending numeric order (such as 0 to
10), date/time columns from January to December and from the first of the month to the
end of the month, and string columns based on the sort order configured for the session.
♦ Return an error. The PowerCenter Server returns the default value for the output ports.
Note: The PowerCenter Server fails the session when it encounters multiple keys for a Lookup
transformation configured to use a dynamic cache.
Dynamic Cache
If you configure a Lookup transformation to use a dynamic cache, you can only use the
equality operator (=) in the lookup condition.
Handling Multiple Matches
You cannot configure handling for multiple matches in a Lookup transformation configured
to use a dynamic cache. The PowerCenter Server fails the session when it encounters multiple
matches either while caching the lookup table or looking up values in the cache that contain
duplicate keys.
198 Chapter 8: Lookup Transformation
Lookup Caches
You can configure a Lookup transformation to cache the lookup file or table. The
PowerCenter Server builds a cache in memory when it processes the first row of data in a
cached Lookup transformation. It allocates memory for the cache based on the amount you
configure in the transformation or session properties. The PowerCenter Server stores
condition values in the index cache and output values in the data cache. The PowerCenter
Server queries the cache for each row that enters the transformation.
The PowerCenter Server also creates cache files by default in the $PMCacheDir. If the data
does not fit in the memory cache, the PowerCenter Server stores the overflow values in the
cache files. When the session completes, the PowerCenter Server releases cache memory and
deletes the cache files unless you configure the Lookup transformation to use a persistent
cache.
When configuring a lookup cache, you can specify any of the following options:
♦ Persistent cache
♦ Recache from lookup source
♦ Static cache
♦ Dynamic cache
♦ Shared cache
Note: You can use a dynamic cache for relational lookups only.
For details on working with lookup caches, see “Lookup Caches” on page 207.
Lookup Caches 199
Configuring Unconnected Lookup Transformations
An unconnected Lookup transformation is separate from the pipeline in the mapping. You
write an expression using the :LKP reference qualifier to call the lookup within another
transformation. Some common uses for unconnected lookups include:
♦ Testing the results of a lookup in an expression
♦ Filtering rows based on the lookup results
♦ Marking rows for update based on the result of a lookup, such as updating slowly changing
dimension tables
♦ Calling the same lookup multiple times in one mapping
Complete the following steps when you configure an unconnected Lookup transformation:
1. Add input ports.
2. Add the lookup condition.
3. Designate a return value.
4. Call the lookup from another transformation.
Step 1. Add Input Ports
Create an input port for each argument in the :LKP expression. For each lookup condition
you plan to create, you need to add an input port to the Lookup transformation. You can
create a different port for each condition, or you can use the same input port in more than
one condition.
For example, a retail store increased prices across all departments during the last month. The
accounting department only wants to load rows into the target for items with increased prices.
To accomplish this, complete the following tasks:
♦ Create a lookup condition that compares the ITEM_ID in the source with the ITEM_ID
in the target.
♦ Compare the PRICE for each item in the source with the price in the target table.
− If the item exists in the target table and the item price in the source is less than or equal
to the price in the target table, you want to delete the row.
− If the price in the source is greater than the item price in the target table, you want to
update the row.
200 Chapter 8: Lookup Transformation
♦ Create an input port (IN_ITEM_ID) with datatype Decimal (37,0) to match the
ITEM_ID and an IN_PRICE input port with Decimal (10,2) to match the PRICE lookup
port.
Step 2. Add the Lookup Condition
Once you correctly configure the ports, define a lookup condition to compare transformation
input values with values in the lookup source or cache. To increase performance, add
conditions with an equal sign first.
In this case, add the following lookup condition:
ITEM_ID = IN_ITEM_ID
PRICE <= IN_PRICE
If the item exists in the mapping source and lookup source and the mapping source price is
less than or equal to the lookup price, the condition is true and the lookup returns the values
designated by the Return port. If the lookup condition is false, the lookup returns NULL.
Therefore, when you write the update strategy expression, use ISNULL nested in an IIF to
test for null values.
Step 3. Designate a Return Value
With unconnected Lookups, you can pass multiple input values into the transformation, but
only one column of data out of the transformation. Designate one lookup/output port as a
return port. The PowerCenter Server can return one value from the lookup query. Use the
return port to specify the return value. If you call the unconnected lookup from an update
strategy or filter expression, you are generally checking for null values. In this case, the return
port can be anything. If, however, you call the lookup from an expression performing a
calculation, the return value needs to be the value you want to include in the calculation.
Configuring Unconnected Lookup Transformations 201
To continue the update strategy example, you can define the ITEM_ID port as the return port.
The update strategy expression checks for null values returned. If the lookup condition is
true, the PowerCenter Server returns the ITEM_ID. If the condition is false, the PowerCenter
Server returns NULL.
Figure 8-2 shows a return port in a Lookup transformation:
Figure 8-2. Return Port in a Lookup Transformation
Return Port
Step 4. Call the Lookup Through an Expression
You supply input values for an unconnected Lookup transformation from a :LKP expression
in another transformation. The arguments are local input ports that match the Lookup
transformation input ports used in the lookup condition. Use the following syntax for a :LKP
expression:
:LKP.lookup_transformation_name(argument, argument, ...)
To continue the example about the retail store, when you write the update strategy expression,
the order of ports in the expression must match the order in the lookup condition. In this
case, the ITEM_ID condition is the first lookup condition, and therefore, it is the first
argument in the update strategy expression.
IIF(ISNULL(:LKP.lkpITEMS_DIM(ITEM_ID, PRICE)), DD_UPDATE, DD_REJECT)
Use the following guidelines to write an expression that calls an unconnected Lookup
transformation:
♦ The order in which you list each argument must match the order of the lookup conditions
in the Lookup transformation.
202 Chapter 8: Lookup Transformation
♦ The datatypes for the ports in the expression must match the datatypes for the input ports
in the Lookup transformation. The Designer does not validate the expression if the
datatypes do not match.
♦ If one port in the lookup condition is not a lookup/output port, the Designer does not
validate the expression.
♦ The arguments (ports) in the expression must be in the same order as the input ports in
the lookup condition.
♦ If you use incorrect :LKP syntax, the Designer marks the mapping invalid.
♦ If you call a connected Lookup transformation in a :LKP expression, the Designer marks
the mapping invalid.
Tip: Avoid syntax errors when you enter expressions by using the point-and-click method to
select functions and ports.
Configuring Unconnected Lookup Transformations 203
Creating a Lookup Transformation
The following steps summarize the process of creating a Lookup transformation.
To create a Lookup transformation:
1. In the Mapping Designer, choose Transformation-Create. Select the Lookup
transformation. Enter a name for the transformation. The naming convention for
Lookup transformations is LKP_TransformationName. Click OK.
2. In the Select Lookup Table dialog box, you can choose the following options:
♦ Choose an existing table or file definition.
♦ Choose to import a definition from a relational table or file.
♦ Skip to create a manual definition.
Choose existing definition.
Import definition.
Manually create a definition.
3. Define input ports for each lookup condition you want to define.
4. For an unconnected Lookup transformation, create a return port for the value you want
to return from the lookup.
5. Define output ports for the values you want to pass to another transformation.
6. For Lookup transformations that use a dynamic lookup cache, associate an input port or
sequence ID with each lookup port.
7. Add the lookup conditions. If you include more than one condition, place the conditions
using equal signs first to optimize lookup performance.
For information about lookup conditions, see “Lookup Condition” on page 197.
8. On the Properties tab, set the properties for the Lookup transformation, and click OK.
For a list of properties, see “Lookup Properties” on page 186.
9. For unconnected Lookup transformations, write an expression in another transformation
using :LKP to call the unconnected Lookup transformation.
204 Chapter 8: Lookup Transformation
Tips
Use the following tips when you configure the Lookup transformation:
Add an index to the columns used in a lookup condition.
If you have privileges to modify the database containing a lookup table, you can improve
performance for both cached and uncached lookups. This is important for very large lookup
tables. Since the PowerCenter Server needs to query, sort, and compare values in these
columns, the index needs to include every column used in a lookup condition.
Place conditions with an equality operator (=) first.
If a Lookup transformation specifies several conditions, you can improve lookup performance
by placing all the conditions that use the equality operator first in the list of conditions that
appear under the Condition tab.
Cache small lookup tables.
Improve session performance by caching small lookup tables. The result of the lookup query
and processing is the same, whether or not you cache the lookup table.
Join tables in the database.
If the lookup table is on the same database as the source table in your mapping and caching is
not feasible, join the tables in the source database rather than using a Lookup transformation.
Use a persistent lookup cache for static lookups.
If the lookup source does not change between sessions, configure the Lookup transformation
to use a persistent lookup cache. The PowerCenter Server then saves and reuses cache files
from session to session, eliminating the time required to read the lookup source.
Call unconnected Lookup transformations with the :LKP reference qualifier.
When you write an expression using the :LKP reference qualifier, you call unconnected
Lookup transformations only. If you try to call a connected Lookup transformation, the
Designer displays an error and marks the mapping invalid.
Tips 205
206 Chapter 8: Lookup Transformation
Chapter 9
Lookup Caches
This chapter includes the following topics:
♦ Overview, 208
♦ Using a Persistent Lookup Cache, 210
♦ Rebuilding the Lookup Cache, 212
♦ Working with an Uncached Lookup or Static Cache, 213
♦ Working with a Dynamic Lookup Cache, 214
♦ Sharing the Lookup Cache, 230
♦ Tips, 237
207
Overview
You can configure a Lookup transformation to cache the lookup table. The PowerCenter
Server builds a cache in memory when it processes the first row of data in a cached Lookup
transformation. It allocates memory for the cache based on the amount you configure in the
transformation or session properties. The PowerCenter Server stores condition values in the
index cache and output values in the data cache. The PowerCenter Server queries the cache
for each row that enters the transformation.
The PowerCenter Server also creates cache files by default in the $PMCacheDir. If the data
does not fit in the memory cache, the PowerCenter Server stores the overflow values in the
cache files. When the session completes, the PowerCenter Server releases cache memory and
deletes the cache files unless you configure the Lookup transformation to use a persistent
cache.
If you use a flat file lookup, the PowerCenter Server always caches the lookup source. If you
configure a flat file lookup for sorted input, the PowerCenter Server cannot cache the lookup
if the condition columns are not grouped. If the columns are grouped, but not sorted, the
PowerCenter Server processes the lookup as if you did not configure sorted input. For more
information, see “Flat File Lookups” on page 181.
When configuring a lookup cache, you can specify any of the following options:
♦ Persistent cache. You can save the lookup cache files and reuse them the next time the
PowerCenter Server processes a Lookup transformation configured to use the cache. For
more information, see “Using a Persistent Lookup Cache” on page 210.
♦ Recache from source. If the persistent cache is not synchronized with the lookup table,
you can configure the Lookup transformation to rebuild the lookup cache. For more
information, see “Rebuilding the Lookup Cache” on page 212.
♦ Static cache. You can configure a static, or read-only, cache for any lookup source. By
default, the PowerCenter Server creates a static cache. It caches the lookup file or table and
looks up values in the cache for each row that comes into the transformation. When the
lookup condition is true, the PowerCenter Server returns a value from the lookup cache.
The PowerCenter Server does not update the cache while it processes the Lookup
transformation. For more information, see “Working with an Uncached Lookup or Static
Cache” on page 213.
♦ Dynamic cache. If you want to cache the target table and insert new rows or update
existing rows in the cache and the target, you can create a Lookup transformation to use a
dynamic cache. The PowerCenter Server dynamically inserts or updates data in the lookup
cache and passes data to the target table. You cannot use a dynamic cache with a flat file
lookup. For more information, see “Working with a Dynamic Lookup Cache” on
page 214.
♦ Shared cache. You can share the lookup cache between multiple transformations. You can
share an unnamed cache between transformations in the same mapping. You can share a
named cache between transformations in the same or different mappings. For more
information, see “Sharing the Lookup Cache” on page 230.
208 Chapter 9: Lookup Caches
When you do not configure the Lookup transformation for caching, the PowerCenter Server
queries the lookup table for each input row. The result of the Lookup query and processing is
the same, whether or not you cache the lookup table. However, using a lookup cache can
increase session performance. Optimize performance by caching the lookup table when the
source table is large.
For more information about caching properties, see “Lookup Properties” on page 186.
For information about configuring the cache size, see “Session Caches” in the Workflow
Administration Guide.
Note: The PowerCenter Server uses the same transformation logic to process a Lookup
transformation whether you configure it to use a static cache or no cache. However, when you
configure the transformation to use no cache, the PowerCenter Server queries the lookup
table instead of the lookup cache.
Cache Comparison
Table 9-1 compares the differences between an uncached lookup, a static cache, and a
dynamic cache:
Table 9-1. Lookup Caching Comparison
Uncached Static Cache Dynamic Cache
You cannot insert or update the You cannot insert or update the You can insert or update rows in the cache
cache. cache. as you pass rows to the target.
You cannot use a flat file lookup. You can use a relational or a flat You can use a relational lookup only.
file lookup.
When the condition is true, the When the condition is true, the When the condition is true, the
PowerCenter Server returns a PowerCenter Server returns a PowerCenter Server either updates rows
value from the lookup table or value from the lookup table or in the cache or leaves the cache
cache. cache. unchanged, depending on the row type.
When the condition is not true, When the condition is not true, the This indicates that the row is in the cache
the PowerCenter Server returns PowerCenter Server returns the and target table. You can pass updated
the default value for connected default value for connected rows to the target table.
transformations and NULL for transformations and NULL for When the condition is not true, the
unconnected transformations. unconnected transformations. PowerCenter Server either inserts rows
For details, see “Working with an For details, see “Working with an into the cache or leaves the cache
Uncached Lookup or Static Uncached Lookup or Static Cache” unchanged, depending on the row type.
Cache” on page 213. on page 213. This indicates that the row is not in the
cache or target table. You can pass
inserted rows to the target table.
For details, see “Updating the Dynamic
Lookup Cache” on page 224.
Overview 209
Using a Persistent Lookup Cache
You can configure a Lookup transformation to use a non-persistent or persistent cache. The
PowerCenter Server saves or deletes lookup cache files after a successful session based on the
Lookup Cache Persistent property.
If the lookup table does not change between sessions, you can configure the Lookup
transformation to use a persistent lookup cache. The PowerCenter Server saves and reuses
cache files from session to session, eliminating the time required to read the lookup table.
Using a Non-Persistent Cache
By default, the PowerCenter Server uses a non-persistent cache when you enable caching in a
Lookup transformation. The PowerCenter Server deletes the cache files at the end of a
session. The next time you run the session, the PowerCenter Server builds the memory cache
from the database.
Using a Persistent Cache
If you want to save and reuse the cache files, you can configure the transformation to use a
persistent cache. Use a persistent cache when you know the lookup table does not change
between session runs.
The first time the PowerCenter Server runs a session using a persistent lookup cache, it saves
the cache files to disk instead of deleting them. The next time the PowerCenter Server runs
the session, it builds the memory cache from the cache files. If the lookup table changes
occasionally, you can override session properties to recache the lookup from the database.
When you use a persistent lookup cache, you can specify a name for the cache files. When you
specify a named cache, you can share the lookup cache across sessions. For more information
about the Cache File Name Prefix property, see “Lookup Properties” on page 186. For more
information about sharing lookup caches, see “Sharing the Lookup Cache” on page 230.
If the PowerCenter Server cannot reuse the cache, it either recaches the lookup from the
database, or it fails the session, depending on the mapping and session properties.
Table 9-2 summarizes how the PowerCenter Server handles persistent caching for named and
unnamed caches:
Table 9-2. PowerCenter Server Handling of Persistent Caches
Mapping or Session Changes Between Sessions Named Cache Unnamed Cache
PowerCenter Server cannot locate cache files. Rebuilds cache. Rebuilds cache.
Enable or disable the Enable High Precision option in session properties. Fails session. Rebuilds cache.
Edit the transformation in the Mapping Designer, Mapplet Designer, or Fails session. Rebuilds cache.
Reusable Transformation Developer.*
Edit the mapping (excluding Lookup transformation). Reuses cache. Rebuilds cache.
210 Chapter 9: Lookup Caches
Table 9-2. PowerCenter Server Handling of Persistent Caches
Mapping or Session Changes Between Sessions Named Cache Unnamed Cache
Change database connection or the file location used to access the lookup Fails session. Rebuilds cache.
table.
Change the PowerCenter Server data movement mode. Fails session. Rebuilds cache.
Change the sort order in Unicode mode. Fails session. Rebuilds cache.
Change the PowerCenter Server code page to a compatible code page. Reuses cache. Reuses cache.
Change the PowerCenter Server code page to an incompatible code page. Fails session. Rebuilds cache.
*Editing properties such as transformation description or port description does not affect persistent cache handling.
Using a Persistent Lookup Cache 211
Rebuilding the Lookup Cache
You can instruct the PowerCenter Server to rebuild the lookup cache if you think that the
lookup source changed since the last time the PowerCenter Server built the cache.
When you rebuild a cache, the PowerCenter Server creates new cache files, overwriting
existing persistent cache files. The PowerCenter Server writes a message to the session log
when it rebuilds the cache.
You can rebuild the cache when the mapping contains one Lookup transformation or when
the mapping contains Lookup transformations in multiple target load order groups that share
a cache. You do not need to rebuild the cache when a dynamic lookup shares the cache with a
static lookup in the same mapping.
Under certain conditions, the PowerCenter Server automatically rebuilds the persistent cache
even if you do not choose to recache the lookup source. For more information, see “Using a
Persistent Cache” on page 210.
212 Chapter 9: Lookup Caches
Working with an Uncached Lookup or Static Cache
By default, the PowerCenter Server creates a static lookup cache when you configure a
Lookup transformation for caching. The PowerCenter Server builds the cache when it
processes the first lookup request. It queries the cache based on the lookup condition for each
row that passes into the transformation. The PowerCenter Server does not update the cache
while it processes the transformation. The PowerCenter Server processes an uncached lookup
the same way it processes a cached lookup except that it queries the lookup source instead of
building and querying the cache.
When the lookup condition is true, the PowerCenter Server returns the values from the
lookup source or cache. For connected Lookup transformations, the PowerCenter Server
returns the values represented by the lookup/output ports. For unconnected Lookup
transformations, the PowerCenter Server returns the value represented by the return port.
When the condition is not true, the PowerCenter Server returns either NULL or default
values. For connected Lookup transformations, the PowerCenter Server returns the default
value of the output port when the condition is not met. For unconnected Lookup
transformations, the PowerCenter Server returns NULL when the condition is not met.
When you create multiple partitions in a pipeline that use a static cache, the PowerCenter
Server creates one memory cache for each partition and one disk cache for each
transformation.
For more information, see “Session Caches” in the Workflow Administration Guide.
Working with an Uncached Lookup or Static Cache 213
Working with a Dynamic Lookup Cache
For relational lookups, you might want to configure the transformation to use a dynamic
cache when the target table is also the lookup table. The PowerCenter Server builds the cache
when it processes the first lookup request. It queries the cache based on the lookup condition
for each row that passes into the transformation. When you use a dynamic cache, the
PowerCenter Server updates the lookup cache as it passes rows to the target.
When the PowerCenter Server reads a row from the source, it updates the lookup cache by
performing one of the following actions:
♦ Inserts the row into the cache. The row is not in the cache and you specified to insert rows
into the cache. You can configure the transformation to insert rows into the cache based on
input ports or generated sequence IDs. The PowerCenter Server flags the row as insert.
♦ Updates the row in the cache. The row exists in the cache and you specified to update
rows in the cache. The PowerCenter Server flags the row as update. The PowerCenter
Server updates the row in the cache based on the input ports.
♦ Makes no change to the cache. The row exists in the cache and you specified to insert new
rows only. Or, the row is not in the cache and you specified to update existing rows only.
Or, the row is in the cache, but based on the lookup condition, nothing changes. The
PowerCenter Server flags the row as unchanged.
The PowerCenter Server either inserts or updates the cache or makes no change to the cache,
based on the results of the lookup query, the row type, and the Lookup transformation
properties you define. For details, see “Updating the Dynamic Lookup Cache” on page 224.
The following list describes some situations when you can use a dynamic lookup cache:
♦ Updating a master customer table with new and updated customer information. You
want to load new and updated customer information into a master customer table. Use a
Lookup transformation that performs a lookup on the target table to determine if a
customer exists or not. Use a dynamic lookup cache that inserts and updates rows in the
cache as it passes rows to the target.
♦ Loading data into a slowly changing dimension table and a fact table. You want to load
data into a slowly changing dimension table and a fact table. Create two pipelines and use
a Lookup transformation that performs a lookup on the dimension table. Use a dynamic
lookup cache to load data to the dimension table. Use a static lookup cache to load data to
the fact table, making sure you specify the name of the dynamic cache from the first
pipeline. For more information, see “Example Using a Dynamic Lookup Cache” on
page 228.
Use a Router or Filter transformation with the dynamic Lookup transformation to route
inserted or updated rows to the cached target table. You can route unchanged rows to another
target table or flat file, or you can drop them.
When you create multiple partitions in a pipeline that use a dynamic lookup cache, the
PowerCenter Server creates one memory cache and one disk cache for each transformation.
However, if you add a partition point at the Lookup transformation, the PowerCenter Server
214 Chapter 9: Lookup Caches
creates one memory cache for each partition. For more information, see “Session Caches” in
the Workflow Administration Guide.
Figure 9-1 shows a mapping with a Lookup transformation that uses a dynamic lookup cache:
Figure 9-1. Mapping With a Dynamic Lookup Cache
A Lookup transformation using a dynamic cache has the following properties:
♦ NewLookupRow. The Designer adds this port to a Lookup transformation configured to
use a dynamic cache. Indicates with a numeric value whether the PowerCenter Server
inserts or updates the row in the cache, or makes no change to the cache. To keep the
lookup cache and the target table synchronized, you pass rows to the target when the
NewLookupRow value is equal to 1 or 2. For more information, see “Using the
NewLookupRow Port” on page 216.
♦ Associated Port. Associate lookup ports with either an input/output port or a sequence
ID. The PowerCenter Server uses the data in the associated ports to insert or update rows
in the lookup cache. If you associate a sequence ID, the PowerCenter Server generates a
primary key for inserted rows in the lookup cache. For more information, see “Using the
Associated Input Port” on page 217.
♦ Ignore Null Inputs for Updates. The Designer activates this port property for lookup/
output ports when you configure the Lookup transformation to use a dynamic cache.
Select this property when you do not want the PowerCenter Server to update the column
in the cache when the data in this column contains a null value. For more information, see
“Using the Ignore Null Property” on page 221.
Working with a Dynamic Lookup Cache 215
♦ Ignore in Comparison. The Designer activates this port property for lookup/output ports
not used in the lookup condition when you configure the Lookup transformation to use a
dynamic cache. The PowerCenter Server compares the values in all lookup ports with the
values in their associated input ports by default. Select this property if you want the
PowerCenter Server to ignore the port when it compares values before updating a row. For
more information, see “Using the Ignore in Comparison Property” on page 222.
Figure 9-2 shows the output port properties unique to a dynamic Lookup transformation:
Figure 9-2. Dynamic Lookup Transformation Ports Tab
NewLookupRow
Associated Sequence-ID
Associated Port
Ignore Null
Ignore in Comparison
Using the NewLookupRow Port
When you define a Lookup transformation to use a dynamic cache, the Designer adds the
NewLookupRow port to the transformation. The PowerCenter Server assigns a value to the
port, depending on the action it performs to the lookup cache.
Table 9-3 lists the possible NewLookupRow values:
Table 9-3. NewLookupRow Values
NewLookupRow Value Description
0 The PowerCenter Server does not update or insert the row in the cache.
1 The PowerCenter Server inserts the row into the cache.
2 The PowerCenter Server updates the row in the cache.
216 Chapter 9: Lookup Caches
When the PowerCenter Server reads a row, it changes the lookup cache depending on the
results of the lookup query and the Lookup transformation properties you define. It assigns
the value 0, 1, or 2 to the NewLookupRow port to indicate if it inserts or updates the row in
the cache, or makes no change.
For details on how the PowerCenter Server determines to update the cache, see “Updating the
Dynamic Lookup Cache” on page 224.
The NewLookupRow value indicates how the PowerCenter Server changes the lookup cache.
It does not change the row type. Therefore, use a Filter or Router transformation and an
Update Strategy transformation to help keep the target table and lookup cache synchronized.
Configure the Filter transformation to pass new and updated rows to the Update Strategy
transformation before passing them to the cached target. Use the Update Strategy
transformation to change the row type of each row to insert or update, depending on the
NewLookupRow value.
You can drop the rows that do not change the cache, or you can pass them to another target.
For more information, see “Using Update Strategy Transformations with a Dynamic Cache”
on page 222.
Define the filter condition in the Filter transformation based on the value of
NewLookupRow. For example, use the following condition to pass both inserted and updated
rows to the cached target:
NewLookupRow != 0
For more information about the Filter transformation, see “Filter Transformation” on
page 147.
Using the Associated Input Port
When you use a dynamic lookup cache, you must associate each lookup/output port with an
input/output port or a sequence ID. The PowerCenter Server uses the data in the associated
port to insert or update rows in the lookup cache. The Designer associates the input/output
ports with the lookup/output ports used in the lookup condition.
For more information about the values of a Lookup transformation when you use a dynamic
lookup cache, see “Working with Lookup Transformation Values” on page 218.
Sometimes you need to create a generated key for a column in the target table. For lookup
ports with an Integer or Small Integer datatype, you can associate a generated key instead of
an input port. To do this, select Sequence-ID in the Associated Port column.
When you select Sequence-ID in the Associated Port column, the PowerCenter Server
generates a key when it inserts a row into the lookup cache.
The PowerCenter Server uses the following process to generate sequence IDs:
1. When the PowerCenter Server creates the dynamic lookup cache, it tracks the range of
values in the cache associated with any port using a sequence ID.
Working with a Dynamic Lookup Cache 217
2. When the PowerCenter Server inserts a new row of data into the cache, it generates a key
for a port by incrementing the greatest sequence ID existing value by one.
3. When the PowerCenter Server reaches the maximum number for a generated sequence
ID, it starts over at one. It then increments each sequence ID by one until it reaches the
smallest existing value minus one. If the PowerCenter Server runs out of unique sequence
ID numbers, the session fails.
Note: The maximum value for a sequence ID is 2147483647.
The PowerCenter Server only generates a sequence ID for rows it inserts into the cache.
Working with Lookup Transformation Values
When you associate an input/output port or a sequence ID with a lookup/output port, the
following values match by default:
♦ Input value. Value the PowerCenter Server passes into the transformation.
♦ Lookup value. Value that the PowerCenter Server inserts into the cache.
♦ Input/output port output value. Value that the PowerCenter Server passes out of the
input/output port.
The lookup/output port output value depends on whether you choose to output old or new
values when the PowerCenter Server updates a row:
♦ Output old values on update. The PowerCenter Server outputs the value that existed in
the cache before it updated the row.
♦ Output new values on update. The PowerCenter Server outputs the updated value that it
writes in the cache. The lookup/output port value matches the input/output port value.
Note: You configure to output old or new values using the Output Old Value On Update
transformation property. For more information about this property, see “Lookup Properties”
on page 186.
For example, you have the following Lookup transformation that uses a dynamic lookup
cache:
You define the following lookup condition:
IN_CUST_ID = CUST_ID
218 Chapter 9: Lookup Caches
By default, the row type of all rows entering the Lookup transformation is insert. To perform
both inserts and updates in the cache and target table, you select the Insert Else Update
property in the Lookup transformation.
The following sections describe the values of the rows in the cache, the input rows, lookup
rows, and output rows as you run the session.
Initial Cache Values
When you run the session, the PowerCenter Server builds the lookup cache from the target
table with the following data:
PK_PRIMARYKEY CUST_ID CUST_NAME ADDRESS
100001 80001 Marion James 100 Main St.
100002 80002 Laura Jones 510 Broadway Ave.
100003 80003 Shelley Lau 220 Burnside Ave.
Input Values
The source contains rows that exist and rows that do not exist in the target table. The
following rows pass into the Lookup transformation from the Source Qualifier
transformation:
SQ_CUST_ID SQ_CUST_NAME SQ_ADDRESS
80001 Marion Atkins 100 Main St.
80002 Laura Gomez 510 Broadway Ave.
99001 Jon Freeman 555 6th Ave.
Note: The input values always match the values the PowerCenter Server outputs out of the
input/output ports.
Lookup Values
The PowerCenter Server looks up values in the cache based on the lookup condition. It
updates rows in the cache for existing customer IDs 80001 and 80002. It inserts a row into
the cache for customer ID 99001. The PowerCenter Server generates a new key
(PK_PRIMARYKEY) for the new row.
PK_PRIMARYKEY CUST_ID CUST_NAME ADDRESS
100001 80001 Marion Atkins 100 Main St.
100002 80002 Laura Gomez 510 Broadway Ave.
100004 99001 Jon Freeman 555 6th Ave.
Working with a Dynamic Lookup Cache 219
Output Values
The PowerCenter Server flags the rows in the Lookup transformation based on the inserts and
updates it performs on the dynamic cache. These rows pass through an Expression
transformation to a Router transformation that filters and passes on the inserted and updated
rows to an Update Strategy transformation. The Update Strategy transformation flags the
rows based on the value of the NewLookupRow port.
The output values of the lookup/output and input/output ports depend on whether you
choose to output old or new values when the PowerCenter Server updates a row. However, the
output values of the NewLookupRow port and any lookup/output port that uses the
Sequence-ID is the same for new and updated rows.
When you choose to output new values, the lookup/output ports output the following values:
NewLookupRow PK_PRIMARYKEY CUST_ID CUST_NAME ADDRESS
2 100001 80001 Marion Atkins 100 Main St.
2 100002 80002 Laura Gomez 510 Broadway Ave.
1 100004 99001 Jon Freeman 555 6th Ave.
When you choose to output old values, the lookup/output ports output the following values:
NewLookupRow PK_PRIMARYKEY CUST_ID CUST_NAME ADDRESS
2 100001 80001 Marion James 100 Main St.
2 100002 80002 Laura Jones 510 Broadway Ave.
1 100004 99001 Jon Freeman 555 6th Ave.
Note that when the PowerCenter Server updates existing rows in the lookup cache and when
it passes rows to the lookup/output ports, it always uses the existing primary key
(PK_PRIMARYKEY) values for rows that exist in the cache and target table.
The PowerCenter Server uses the sequence ID to generate a new primary key for the customer
that it does not find in the cache. The PowerCenter Server inserts the new primary key value
into the lookup cache and outputs it to the lookup/output port.
The PowerCenter Server output values from the input/output ports that match the input
values. For those values, see “Input Values” on page 219.
Note: If the input value is NULL and you select the Ignore Null property for the associated
input port, the input value does not equal the lookup value or the value out of the input/
output port. When you select the Ignore Null property, the lookup cache and the target table
might become unsynchronized if you pass null values to the target. You must verify that you
do not pass null values to the target. For more information, see “Using the Ignore Null
Property” on page 221.
220 Chapter 9: Lookup Caches
Using the Ignore Null Property
When you update a dynamic lookup cache and target table, the source data might contain
some null values. The PowerCenter Server can handle the null values in the following ways:
♦ Insert null values. The PowerCenter Server uses null values from the source and updates
the lookup cache and target table using all values from the source.
♦ Ignore null values. The PowerCenter Server ignores the null values in the source and
updates the lookup cache and target table using only the not null values from the source.
If you know the source data contains null values, and you do not want the PowerCenter
Server to update the lookup cache or target with null values, select the Ignore Null property
for the corresponding lookup/output port.
For example, you want to update your master customer table. The source contains new
customers and current customers whose last names have changed. The source contains the
customer IDs and names of customers whose names have changed, but it contains null values
for the address columns. You want to insert new customers and update the current customer
names while retaining the current address information in a master customer table.
For example, the master customer table contains the following data:
PRIMARYKEY CUST_ID CUST_NAME ADDRESS CITY STATE ZIP
100001 80001 Marion James 100 Main St. Mt. View CA 94040
100002 80002 Laura Jones 510 Broadway Ave. Raleigh NC 27601
100003 80003 Shelley Lau 220 Burnside Ave. Portland OR 97210
The source contains the following data:
CUST_ID CUST_NAME ADDRESS CITY STATE ZIP
80001 Marion Atkins NULL NULL NULL NULL
80002 Laura Gomez NULL NULL NULL NULL
99001 Jon Freeman 555 6th Ave. San Jose CA 95051
Select Insert Else Update in the Lookup transformation in the mapping. Select the Ignore
Null option for all lookup/output ports in the Lookup transformation. When you run a
session, the PowerCenter Server ignores null values in the source data and updates the lookup
cache and the target table with not null values:
PRIMARYKEY CUST_ID CUST_NAME ADDRESS CITY STATE ZIP
100001 80001 Marion Atkins 100 Main St. Mt. View CA 94040
100002 80002 Laura Gomez 510 Broadway Ave. Raleigh NC 27601
100003 80003 Shelley Lau 220 Burnside Ave. Portland OR 97210
100004 99001 Jon Freeman 555 6th Ave. San Jose CA 95051
Note: When you choose to ignore NULLs, you must verify that you output the same values to
the target that the PowerCenter Server writes to the lookup cache. When you choose to ignore
Working with a Dynamic Lookup Cache 221
NULLs, the lookup cache and the target table might become unsynchronized if you pass null
input values to the target. Configure the mapping based on the value you want the
PowerCenter Server to output from the lookup/output ports when it updates a row in the
cache:
♦ New values. Connect only lookup/output ports from the Lookup transformation to the
target.
♦ Old values. Add an Expression transformation after the Lookup transformation and before
the Filter or Router transformation. Add output ports in the Expression transformation for
each port in the target table and create expressions to ensure you do not output null input
values to the target.
Using the Ignore in Comparison Property
When you run a session that uses a dynamic lookup cache, the PowerCenter Server compares
the values in all lookup ports with the values in their associated input ports by default. It
compares the values to determine whether or not to update the row in the lookup cache.
When a value in an input port differs from the value in the lookup port, the PowerCenter
Server updates the row in the cache.
If you do not want to compare all ports, you can choose the ports you want the PowerCenter
Server to ignore when it compares ports. The Designer only enables this property for lookup/
output ports when the port is not used in the lookup condition. You can improve
performance by ignoring some ports during comparison.
You might want to do this when the source data includes a column that indicates whether or
not the row contains data you need to update. Select the Ignore in Comparison property for
all lookup ports except the port that indicates whether or not to update the row in the cache
and target table.
Note: You must configure the Lookup transformation to compare at least one port. The
PowerCenter Server fails the session when you ignore all ports.
Using Update Strategy Transformations with a Dynamic Cache
When you use a dynamic lookup cache, use Update Strategy transformations to define the
row type for the following rows:
♦ Rows entering the Lookup transformation. By default, the row type of all rows entering a
Lookup transformation is insert. However, you can use an Update Strategy transformation
before a Lookup transformation to define all rows as update, or some as update and some
as insert.
♦ Rows leaving the Lookup transformation. The NewLookupRow value indicates how the
PowerCenter Server changed the lookup cache, but it does not change the row type. Use a
Filter or Router transformation after the Lookup transformation to direct rows leaving the
Lookup transformation based on the NewLookupRow value. Use Update Strategy
transformations after the Filter or Router transformation to flag rows for insert or update
before the target definition in the mapping.
222 Chapter 9: Lookup Caches
Note: If you want to drop the unchanged rows, do not connect rows from the Filter or Router
transformation with the NewLookupRow equal to 0 to the target definition.
When you define the row type as insert for rows entering a Lookup transformation, you can
use the Insert Else Update property in the Lookup transformation. When you define the row
type as update for rows entering a Lookup transformation, you can use the Update Else Insert
property in the Lookup transformation. If you define some rows entering a Lookup
transformation as update and some as insert, you can use either the Update Else Insert or
Insert Else Update property, or you can use both properties. For more information, see
“Updating the Dynamic Lookup Cache” on page 224.
Figure 9-3 shows a mapping with multiple Update Strategy transformations and a Lookup
transformation using a dynamic cache:
Figure 9-3. Using Update Strategy Transformations with a Lookup Transformation
Update Strategy marks
rows as update.
Update Strategy
inserts new rows into
the target.
Update Strategy
updates existing rows
in the target.
Output rows not
connected to a target
get dropped.
In this case, the Update Strategy transformation before the Lookup transformation flags all
rows as update. Select the Update Else Insert property in the Lookup transformation. The
Router transformation sends the inserted rows to the Insert_New Update Strategy
transformation and sends the updated rows to the Update_Existing Update Strategy
transformation. The two Update Strategy transformations to the right of the Lookup
transformation flag the rows for insert or update for the target.
Configuring Sessions with a Dynamic Lookup Cache
When you configure a session using Update Strategy transformations and a dynamic lookup
cache, you must define certain session properties.
On the General Options settings on the Properties tab in the session properties, define the
Treat Source Rows As option as Data Driven.
You must also define the following update strategy target table options:
♦ Select Insert
Working with a Dynamic Lookup Cache 223
♦ Select Update as Update
♦ Do not select Delete
These update strategy target table options ensure that the PowerCenter Server updates rows
marked for update and inserts rows marked for insert.
If you do not choose Data Driven, the PowerCenter Server flags all rows for the row type you
specify in the Treat Source Rows As option and does not use the Update Strategy
transformations in the mapping to flag the rows. The PowerCenter Server does not insert and
update the correct rows. If you do not choose Update as Update, the PowerCenter Server does
not correctly update the rows flagged for update in the target table. As a result, the lookup
cache and target table might become unsynchronized. For details, see “Setting the Update
Strategy for a Session” on page 383.
For more information about configuring target session properties, see “Working with Targets”
in the Workflow Administration Guide.
Updating the Dynamic Lookup Cache
When you use a dynamic lookup cache, define the row type of the rows entering the Lookup
transformation as either insert or update. You can define some rows as insert and some as
update, or all insert, or all update. By default, the row type of all rows entering a Lookup
transformation is insert. You can add an Update Strategy transformation before the Lookup
transformation to define the row type as update. For more information, see “Using Update
Strategy Transformations with a Dynamic Cache” on page 222.
The PowerCenter Server either inserts or updates rows in the cache, or does not change the
cache. The row type of the rows entering the Lookup transformation and the lookup query
result affect how the PowerCenter Server updates the cache. However, you must also
configure the following Lookup properties to determine how the PowerCenter Server updates
the lookup cache:
♦ Insert Else Update. Applies to rows entering the Lookup transformation with the row type
of insert.
♦ Update Else Insert. Applies to rows entering the Lookup transformation with the row type
of update.
Note: You can select either the Insert Else Update or Update Else Insert property, or you can
select both properties or neither property. The Insert Else Update property only affects rows
entering the Lookup transformation with the row type of insert. The Update Else Insert
property only affects rows entering the Lookup transformation with the row type of update.
Insert Else Update
You can select the Insert Else Update property in the Lookup transformation. This property
only applies to rows entering the Lookup transformation with the row type of insert. When a
row of any other row type, such as update, enters the Lookup transformation, this property
has no effect on how the PowerCenter Server handles the row.
224 Chapter 9: Lookup Caches
When you select this property and the row type entering the Lookup transformation is insert,
the PowerCenter Server inserts the row into the cache if it is new. The PowerCenter Server
updates the row in the cache if it exists and is different than the existing row.
If you do not select this property and the row type entering the Lookup transformation is
insert, the PowerCenter Server inserts the row into the cache if it is new, and makes no change
to the cache if the row exists.
Table 9-4 describes how the PowerCenter Server changes the lookup cache when the row type
of the rows entering the Lookup transformation is insert:
Table 9-4. Dynamic Lookup Cache Behavior for Insert Row Type
Insert Else Update Option Row Found in Cache Lookup Cache Result NewLookupRow Value
Cleared (insert only) Yes No change 0
No Insert 1
Selected Yes Update 2*
No Insert 1
*If you select Ignore Null for all lookup ports not in the lookup condition and if all those ports contain null values, the PowerCenter Server
does not change the cache and the NewLookupRow value equals 0. For more information, see “Using the Ignore Null Property” on
page 221.
Update Else Insert
You can select the Update Else Insert property in the Lookup transformation. This property
only applies to rows entering the Lookup transformation with the row type of update. When a
row of any other row type, such as insert, enters the Lookup transformation, this property has
no effect on how the PowerCenter Server handles the row.
When you select this property and the row type entering the Lookup transformation is
update, the PowerCenter Server updates the row in the cache if it exists and is different than
the existing row. The PowerCenter Server inserts the row in the cache if it is new.
If you do not select this property and the row type entering the Lookup transformation is
update, the PowerCenter Server updates the row in the cache if it exists, and makes no change
to the cache if the row is new.
Table 9-5 describes how the PowerCenter Server changes the lookup cache when the row type
of the rows entering the Lookup transformation is update:
Table 9-5. Dynamic Lookup Cache Behavior for Update Row Type
Update Else Insert Option Row Found in Cache Lookup Cache Result NewLookupRow Value
Cleared (update only) Yes Update 2*
No No change 0
Working with a Dynamic Lookup Cache 225
Table 9-5. Dynamic Lookup Cache Behavior for Update Row Type
Update Else Insert Option Row Found in Cache Lookup Cache Result NewLookupRow Value
Selected Yes Update 2*
No Insert 1
*If you select Ignore Null for all lookup ports not in the lookup condition and if all those ports contain null values, the PowerCenter Server
does not change the cache and the NewLookupRow value equals 0. For more information, see “Using the Ignore Null Property” on
page 221.
Using the WHERE Clause with a Dynamic Cache
When you add a WHERE clause in the lookup SQL override, the PowerCenter Server uses
the WHERE clause to build the cache from the database and to perform a lookup on the
database table for an uncached lookup. However, it does not use the WHERE clause to insert
rows into a dynamic cache when it runs a session.
When you add a WHERE clause in a Lookup transformation using a dynamic cache, connect
a Filter transformation before the Lookup transformation to filter rows you do not want to
insert into the cache or target table. If you do not use a Filter transformation, you might get
inconsistent data.
For example, you configure a Lookup transformation to perform a dynamic lookup on the
employee table, EMP, matching rows by EMP_ID. You define the following lookup SQL
override:
SELECT EMP_ID, EMP_STATUS FROM EMP ORDER BY EMP_ID, EMP_STATUS WHERE
EMP_STATUS = 4
When you first run the session, the PowerCenter Server builds the lookup cache from the
target table based on the lookup SQL override. Therefore, all rows in the cache match the
condition in the WHERE clause, EMP_STATUS = 4.
Suppose the PowerCenter Server reads a source row that meets the lookup condition you
specify (the value for EMP_ID is found in the cache), but the value of EMP_STATUS is 2.
The PowerCenter Server does not find the row in the cache, so it inserts the row into the
cache and passes the row to the target table. When this happens, not all rows in the cache
match the condition in the WHERE clause. When the PowerCenter Server tries to insert this
row in the target table, you might get inconsistent data if the row already exists there.
To verify that you only insert rows into the cache that match the WHERE clause, add a Filter
transformation before the Lookup transformation and define the filter condition as the
condition in the WHERE clause in the lookup SQL override.
For the example above, enter the following filter condition:
EMP_STATUS = 4
For more information about the lookup SQL override, see “Overriding the Lookup Query”
on page 193.
226 Chapter 9: Lookup Caches
Synchronizing the Dynamic Lookup Cache
When you use a dynamic lookup cache, the PowerCenter Server writes to the lookup cache
before it writes to the target table. The lookup cache and target table can become
unsynchronized if the PowerCenter Server does not write the data to the target. For example,
the target database or Informatica writer might reject the data.
Use the following guidelines to keep the lookup cache synchronized with the lookup table:
♦ Use a Router transformation to pass rows to the cached target when the NewLookupRow
value equals one or two. You can use the Router transformation to drop rows when the
NewLookupRow value equals zero, or you can output those rows to a different target.
♦ Use Update Strategy transformations after the Lookup transformation to flag rows for
insert or update into the target.
♦ Set the error threshold to one when you run a session. When you set the error threshold to
one, the session fails when it encounters the first error. The PowerCenter Server does not
write the new cache files to disk. Instead, it restores the original cache files, if they exist.
You must also restore the pre-session target table to the target database. For more
information about setting the error threshold, see “Working with Sessions” in the
Workflow Administration Guide.
♦ Verify that you output the same values to the target that the PowerCenter Server writes to
the lookup cache. When you choose to output new values on update, only connect lookup/
output ports to the target table instead of input/output ports. When you choose to output
old values on update, add an Expression transformation after the Lookup transformation
and before the Router transformation. Add output ports in the Expression transformation
for each port in the target table and create expressions to ensure you do not output null
input values to the target.
♦ Set the Treat Source Rows As property to Data Driven in the session properties.
♦ Select Insert and Update as Update when you define the update strategy target table
options in the session properties. This ensures that the PowerCenter Server updates rows
marked for update and inserts rows marked for insert. Select these options in the
Transformations View on the Mapping tab in the session properties. For more
information, see “Working with Targets” in the Workflow Administration Guide.
Null Values in Lookup Condition Columns
Sometimes when you run a session, the source data may contain null values in columns used
in the lookup condition. The PowerCenter Server handles rows with null values in lookup
condition columns differently, depending on whether the row exists in the cache:
♦ If the row does not exist in the lookup cache, the PowerCenter Server inserts the row in the
cache and passes it to the target table.
♦ If the row does exist in the lookup cache, the PowerCenter Server does not update the row
in the cache or target table.
Note: If the source data contains null values in the lookup condition columns, set the error
threshold to one. This ensures that the lookup cache and table remain synchronized if the
Working with a Dynamic Lookup Cache 227
PowerCenter Server inserts a row in the cache, but the database rejects the row due to a Not
Null constraint.
Example Using a Dynamic Lookup Cache
You can use a dynamic lookup cache when you need to insert and update rows in your target.
When you use a dynamic lookup cache, you can insert and update the cache with the same
data you pass to the target to insert and update.
For example, you can use a dynamic lookup cache to update a table that contains customer
data. Your source data contains rows that you need to insert into the target and rows you need
to update in the target.
Figure 9-4 shows a mapping that uses a dynamic cache:
Figure 9-4. Slowly Changing Dimension Mapping with Dynamic Lookup Cache
The Lookup transformation uses a dynamic lookup cache. When the session starts, the
PowerCenter Server builds the lookup cache from the target table. When the PowerCenter
Server reads a row that is not in the lookup cache, it inserts the row in the cache and then
passes the row out of the Lookup transformation. The Router transformation directs the row
to the UPD_Insert_New Update Strategy transformation. The Update Strategy
transformation marks the row as insert before passing it to the target.
The target table changes as the session runs, and the PowerCenter Server inserts new rows and
updates existing rows in the lookup cache. The PowerCenter Server keeps the lookup cache
and target table synchronized.
To generate keys for the target, use Sequence-ID in the associated port. The sequence ID
generates primary keys for new rows the PowerCenter Server inserts into the target table.
Without the dynamic lookup cache, you need to use two Lookup transformations in your
mapping. Use the first Lookup transformation to insert rows in the target. Use the second
Lookup transformation to recache the target table and update rows in the target table.
You increase session performance when you use a dynamic lookup cache because you only
need to build the cache from the database once. You can continue to use the lookup cache
even though the data in the target table changes.
228 Chapter 9: Lookup Caches
Rules and Guidelines for Dynamic Caches
Use the following guidelines when you use a dynamic lookup cache:
♦ The Lookup transformation must be a connected transformation.
♦ You can use a persistent or a non-persistent cache.
♦ If the dynamic cache is not persistent, the PowerCenter Server always rebuilds the cache
from the database, even if you do not enable Recache from Lookup Source.
♦ You cannot share the cache between a dynamic Lookup transformation and static Lookup
transformation in the same target load order group.
♦ You can only create an equality lookup condition. You cannot look up a range of data.
♦ Associate each lookup port (that is not in the lookup condition) with an input port or a
sequence ID.
♦ Use a Router transformation to pass rows to the cached target when the NewLookupRow
value equals one or two. You can use the Router transformation to drop rows when the
NewLookupRow value equals zero, or you can output those rows to a different target.
♦ Verify that you output the same values to the target that the PowerCenter Server writes to
the lookup cache. When you choose to output new values on update, only connect lookup/
output ports to the target table instead of input/output ports. When you choose to output
old values on update, add an Expression transformation after the Lookup transformation
and before the Router transformation. Add output ports in the Expression transformation
for each port in the target table and create expressions to ensure you do not output null
input values to the target.
♦ When you use a lookup SQL override, make sure you map the correct columns to the
appropriate targets for lookup.
♦ When you add a WHERE clause to the lookup SQL override, use a Filter transformation
before the Lookup transformation. This ensures the PowerCenter Server only inserts rows
in the dynamic cache and target table that match the WHERE clause. For details, see
“Using the WHERE Clause with a Dynamic Cache” on page 226.
♦ When you configure a reusable Lookup transformation to use a dynamic cache, you
cannot edit the condition or disable the Dynamic Lookup Cache property in a mapping.
♦ Use Update Strategy transformations after the Lookup transformation to flag the rows for
insert or update for the target.
♦ Use an Update Strategy transformation before the Lookup transformation to define some
or all rows as update if you want to use the Update Else Insert property in the Lookup
transformation.
♦ Set the row type to Data Driven in the session properties.
♦ Select Insert and Update as Update for the target table options in the session properties.
Working with a Dynamic Lookup Cache 229
Sharing the Lookup Cache
You can configure multiple Lookup transformations in a mapping to share a single lookup
cache. The PowerCenter Server builds the cache when it processes the first Lookup
transformation. It uses the same cache to perform lookups for subsequent Lookup
transformations that share the cache.
You can share caches that are unnamed and named:
♦ Unnamed cache. When Lookup transformations in a mapping have compatible caching
structures, the PowerCenter Server shares the cache by default. You can only share static
unnamed caches.
♦ Named cache. Use a persistent named cache when you want to share a cache file across
mappings or share a dynamic and a static cache. The caching structures must match or be
compatible with a named cache. You can share static and dynamic named caches.
When the PowerCenter Server shares a lookup cache, it writes a message in the session log.
Sharing an Unnamed Lookup Cache
By default, the PowerCenter Server shares the cache for Lookup transformations in a mapping
that have compatible caching structures. For example, if you have two instances of the same
reusable Lookup transformation in one mapping and you use the same output ports for both
instances, the Lookup transformations share the lookup cache by default.
When two Lookup transformations share an unnamed cache, the PowerCenter Server saves
the cache for a Lookup transformation and uses it for subsequent Lookup transformations
that have the same lookup cache structure.
If the transformation properties or the cache structure do not allow sharing, the PowerCenter
Server creates a new cache.
Guidelines for Sharing an Unnamed Lookup Cache
Use the following guidelines when you configure Lookup transformations to share an
unnamed cache:
♦ You can share static unnamed caches.
♦ Shared transformations must use the same ports in the lookup condition. The conditions
can use different operators, but the ports must be the same.
♦ You must configure some of the transformation properties to enable unnamed cache
sharing. For more information, see Table 9-6 on page 231.
♦ The structure of the cache for the shared transformations must be compatible.
− If you use hash auto-keys partitioning, the lookup/output ports for each transformation
must match.
230 Chapter 9: Lookup Caches
− If you do not use hash auto-keys partitioning, the lookup/output ports for the first
shared transformation must match or be a superset of the lookup/output ports for
subsequent transformations.
♦ If the Lookup transformations with hash auto-keys partitioning are in different target load
order groups, you must configure the same number of partitions for each group. If you do
not use hash auto-keys partitioning, you can configure a different number of partitions for
each target load order group.
Table 9-6 shows when you can share an unnamed static and dynamic cache:
Table 9-6. Location for Sharing Unnamed Cache
Shared Cache Location of Transformations
Static with Static Anywhere in the mapping.
Dynamic with Dynamic Cannot share.
Dynamic with Static Cannot share.
Table 9-7 describes the guidelines to follow when you configure Lookup transformations to
share a named cache:
Table 9-7. Properties for Named Shared Lookup Transformations
Properties Configuration for Named Shared Cache
Lookup SQL Override If you use the Lookup SQL Override property, you must use the same override in all
shared transformations.
Lookup Table Name Must match.
Lookup Caching Enabled Must be enabled.
Lookup Policy on Multiple n/a
Match
Lookup Condition Shared transformations must use the same ports in the lookup condition. The
conditions can use different operators, but the ports must be the same.
Connection Information The connection must be the same. When you configure the sessions, the database
connection must match.
Source Type Must match.
Tracing Level n/a
Lookup Cache Directory Name Does not need to match.
Lookup Cache Persistent Optional. You can share persistent and non-persistent.
Lookup Data Cache Size The PowerCenter Server allocates memory for the first shared transformation in
each pipeline stage. It does not allocate additional memory for subsequent shared
transformations in the same pipeline stage.
For details on pipeline stages, see “Pipeline Partitioning” in the Workflow
Administration Guide.
Sharing the Lookup Cache 231
Table 9-7. Properties for Named Shared Lookup Transformations
Properties Configuration for Named Shared Cache
Lookup Index Cache Size The PowerCenter Server allocates memory for the first shared transformation in
each pipeline stage. It does not allocate additional memory for subsequent shared
transformations in the same pipeline stage.
For details on pipeline stages, see “Pipeline Partitioning” in the Workflow
Administration Guide.
Dynamic Lookup Cache You cannot share an unnamed dynamic cache.
Output Old Value On Update Does not need to match.
Cache File Name Prefix Do not use. You cannot share a named cache with an unnamed cache.
Recache From Lookup Source If you configure a Lookup transformation to recache from source, subsequent
Lookup transformations in the target load order group can share the existing cache
whether or not you configure them to recache from source. If you configure
subsequent Lookup transformations to recache from source, the PowerCenter
Server shares the cache instead of rebuilding the cache when it processes the
subsequent Lookup transformation.
If you do not configure the first Lookup transformation in a target load order group to
recache from source, and you do configure the subsequent Lookup transformation to
recache from source, the transformations cannot share the cache. The PowerCenter
Server builds the cache when it processes each Lookup transformation.
Lookup/Output Ports The lookup/output ports for the second Lookup transformation must match or be a
subset of the ports in the transformation that the PowerCenter Server uses to build
the cache. The order of the ports do not need to match.
Insert Else Update n/a
Update Else Insert n/a
Datetime Format n/a
Thousand Separator n/a
Decimal Separator n/a
Case-Sensitive String Must match.
Comparison
Null Ordering Must match.
Sorted Input n/a
Sharing a Named Lookup Cache
You can also share the cache between multiple Lookup transformations by using a persistent
lookup cache and naming the cache files. You can share one cache between Lookup
transformations in the same mapping or across mappings.
232 Chapter 9: Lookup Caches
The PowerCenter Server uses the following process to share a named lookup cache:
1. When the PowerCenter Server processes the first Lookup transformation, it searches the
cache directory for cache files with the same file name prefix. For more information
about the Cache File Name Prefix property, see “Lookup Properties” on page 186.
2. If the PowerCenter Server finds the cache files and you do not specify to recache from
source, the PowerCenter Server uses the saved cache files.
3. If the PowerCenter Server does not find the cache files or if you specify to recache from
source, the PowerCenter Server builds the lookup cache using the database table.
4. The PowerCenter Server saves the cache files to disk after it processes each target load
order group.
5. The PowerCenter Server uses the following rules to process the second Lookup
transformation with the same cache file name prefix:
♦ The PowerCenter Server uses the memory cache if the transformations are in the same
target load order group.
♦ The PowerCenter Server rebuilds the memory cache from the persisted files if the
transformations are in different target load order groups.
♦ The PowerCenter Server rebuilds the cache from the database if you configure the
transformation to recache from source and the first transformation is in a different
target load order group.
♦ The PowerCenter Server fails the session if you configure subsequent Lookup
transformations to recache from source, but not the first one in the same target load
order group.
♦ If the cache structures do not match, the PowerCenter Server fails the session.
If you run two sessions simultaneously that share a lookup cache, the PowerCenter Server uses
the following rules to share the cache files:
♦ The PowerCenter Server processes multiple sessions simultaneously when the Lookup
transformations only need to read the cache files.
♦ The PowerCenter Server fails the session if one session updates a cache file while another
session attempts to read or update the cache file. For example, Lookup transformations
update the cache file if they are configured to use a dynamic cache or recache from source.
Guidelines for Sharing a Named Lookup Cache
Use the following guidelines when you configure Lookup transformations to share a named
cache:
♦ You can share any combination of dynamic and static caches, but you must follow the
guidelines for location. For more information, see Table 9-8 on page 234.
♦ You must configure some of the transformation properties to enable named cache sharing.
For more information, see Table 9-9 on page 234.
♦ A dynamic lookup cannot share the cache if the named cache has duplicate rows.
Sharing the Lookup Cache 233
♦ A named cache created by a dynamic Lookup transformation with a lookup policy of error
on multiple match can be shared by a static or dynamic Lookup transformation with any
lookup policy.
♦ A named cache created by a dynamic Lookup transformation with a lookup policy of use
first or use last can be shared by a Lookup transformation with the same lookup policy.
♦ Shared transformations must use exactly the same output ports in the mapping. The
criteria and result columns for the cache must match the cache files.
The PowerCenter Server might use the memory cache, or it might build the memory cache
from the file, depending on the type and location of the Lookup transformations.
Table 9-8 shows when you can share a static and dynamic named cache:
Table 9-8. Location for Sharing Named Cache
Shared Cache Location of Transformations Cache Shared
Static with Static - Same target load order group. - PowerCenter Server uses memory cache.
- Separate target load order groups. - PowerCenter Server uses memory cache.
- Separate mappings. - PowerCenter Server builds memory cache from file.
Dynamic with Dynamic - Separate target load order groups. - PowerCenter Server uses memory cache.
- Separate mappings. - PowerCenter Server builds memory cache from file.
Dynamic with Static - Separate target load order groups. - PowerCenter Server builds memory cache from file.
- Separate mappings. - PowerCenter Server builds memory cache from file.
For more information about target load order groups, see “Mappings” in the Designer Guide.
Table 9-9 describes the guidelines to follow when you configure Lookup transformations to
share a named cache:
Table 9-9. Properties for Named Shared Lookup Transformations
Properties Configuration for Named Shared Cache
Lookup SQL Override If you use the Lookup SQL Override property, you must use the same override in all
shared transformations.
Lookup Table Name Must match.
Lookup Caching Enabled Must be enabled.
Lookup Policy on Multiple - A named cache created by a dynamic Lookup transformation with a lookup policy of
Match error on multiple match can be shared by a static or dynamic Lookup transformation
with any lookup policy.
- A named cache created by a dynamic Lookup transformation with a lookup policy of
use first or use last can be shared by a Lookup transformation with the same lookup
policy.
Lookup Condition Shared transformations must use the same ports in the lookup condition. The conditions
can use different operators, but the ports must be the same.
Connection Information The connection must be the same. When you configure the sessions, the database
connection must match.
Source Type Must match.
234 Chapter 9: Lookup Caches
Table 9-9. Properties for Named Shared Lookup Transformations
Properties Configuration for Named Shared Cache
Tracing Level n/a
Lookup Cache Directory Must match.
Name
Lookup Cache Persistent Must be enabled.
Lookup Data Cache Size When transformations within the same mapping share a cache, the PowerCenter Server
allocates memory for the first shared transformation in each pipeline stage. It does not
allocate additional memory for subsequent shared transformations in the same pipeline
stage. For details on pipeline stages, see “Pipeline Partitioning” in the Workflow
Administration Guide.
Lookup Index Cache Size When transformations within the same mapping share a cache, the PowerCenter Server
allocates memory for the first shared transformation in each pipeline stage. It does not
allocate additional memory for subsequent shared transformations in the same pipeline
stage. For details on pipeline stages, see “Pipeline Partitioning” in the Workflow
Administration Guide.
Dynamic Lookup Cache For more information about sharing static and dynamic cache, see Table 9-8 on
page 234.
Output Old Value on Update Does not need to match.
Cache File Name Prefix Must match. Enter the prefix only. Do not enter the .idx or .dat. You cannot share a
named cache with an unnamed cache.
Recache from Source If you configure a Lookup transformation to recache from source, subsequent Lookup
transformations in the target load order group can share the existing cache whether or
not you configure them to recache from source. If you configure subsequent Lookup
transformations to recache from source, the PowerCenter Server shares the cache
instead of rebuilding the cache when it processes the subsequent Lookup
transformation.
If you do not configure the first Lookup transformation in a target load order group to
recache from source, and you do configure the subsequent Lookup transformation to
recache from source, the session fails.
Lookup/Output Ports The lookup/output ports must be identical, but they do not need to be in the same order.
Insert Else Update n/a
Update Else Insert n/a
Thousand Separator n/a
Decimal Separator n/a
Case-Sensitive String n/a
Comparison
Null Ordering n/a
Sorted Input Must match.
Note: You cannot share a lookup cache created on a different operating system. For example,
only a PowerCenter Server on UNIX can read a lookup cache created on a PowerCenter
Sharing the Lookup Cache 235
Server on UNIX, and only a PowerCenter Server on Windows can read a lookup cache created
on a PowerCenter Server on Windows.
236 Chapter 9: Lookup Caches
Tips
Use the following tips when you configure the Lookup transformation to cache the lookup
table:
Cache small lookup tables.
Improve session performance by caching small lookup tables. The result of the lookup query
and processing is the same, whether or not you cache the lookup table.
Use a persistent lookup cache for static lookup tables.
If the lookup table does not change between sessions, configure the Lookup transformation to
use a persistent lookup cache. The PowerCenter Server then saves and reuses cache files from
session to session, eliminating the time required to read the lookup table.
Tips 237
238 Chapter 9: Lookup Caches
Chapter 10
Normalizer
Transformation
This chapter includes the following topics:
♦ Overview, 240
♦ Normalizing Data in a Mapping, 241
♦ Differences Between Normalizer Transformations, 246
♦ Troubleshooting, 247
239
Overview
Transformation type:
Active
Connected
Normalization is the process of organizing data. In database terms, this includes creating
normalized tables and establishing relationships between those tables according to rules
designed to both protect the data and make the database more flexible by eliminating
redundancy and inconsistent dependencies.
The Normalizer transformation normalizes records from COBOL and relational sources,
allowing you to organize the data according to your own needs. A Normalizer transformation
can appear anywhere in a pipeline when you normalize a relational source. Use a Normalizer
transformation instead of the Source Qualifier transformation when you normalize a COBOL
source. When you drag a COBOL source into the Mapping Designer workspace, the
Mapping Designer creates a Normalizer transformation with input and output ports for every
column in the source.
You primarily use the Normalizer transformation with COBOL sources, which are often
stored in a denormalized format. The OCCURS statement in a COBOL file nests multiple
records of information in a single record. Using the Normalizer transformation, you break out
repeated data within a record into separate records. For each new record it creates, the
Normalizer transformation generates a unique identifier. You can use this key value to join the
normalized records.
You can also use the Normalizer transformation with relational sources to create multiple rows
from a single row of data.
240 Chapter 10: Normalizer Transformation
Normalizing Data in a Mapping
Although the Normalizer transformation is designed to handle data read from COBOL
sources, you can also use it to denormalize data from any type of source in a mapping. You
can add a Normalizer transformation to any data flow within a mapping to normalize
components of a single record that contains denormalized data.
If you have denormalized data for which the Normalizer transformation has created key
values, connect the ports representing the repeated data and the output port for the generated
keys to a different pipeline branch in the mapping. Ultimately, you may want to write these
values to different targets.
You can use a single Normalizer transformation to handle multiple levels of denormalization
in the same record. For example, a single record might contain two different detail record sets.
Rather than using two Normalizer transformations to handle the two different detail record
sets, you handle both normalizations in the same transformation.
Normalizer Ports
When you create a Normalizer for a COBOL source, or in the mapping pipeline, the
Designer identifies the OCCURS and REDEFINES statements and generates the following
columns:
♦ Generated key. One port for each REDEFINES clause. For more information, see
“Generated Key” on page 241.
♦ Generated Column ID. One port for each OCCURS clause. For more information, see
“Generated Column ID” on page 242.
You can use these ports for primary and foreign key columns. The Normalizer key and
column ID columns are also useful when you want to pivot input columns into rows. You
cannot delete these ports.
Generated Key
The Designer generates a port for each REDEFINES clause to specify the generated key. You
can use the generated key as a primary key column in the target table and to create a primary-
foreign key relationship. The naming convention for the Normalizer generated key is:
GK_<redefined_field_name>
As shown in Figure 10-1 on page 243, the Designer adds one column (GK_FILE_ONE and
GK_HST_AMT) for each REDEFINES in the COBOL source. The Normalizer GK columns
tell you the order of records in a REDEFINES clause. For example, if a COBOL file has 10
records, when you run the workflow, the PowerCenter Server numbers the first record 1, the
second record 2, and so on.
You can create approximately two billion primary or foreign key values with the Normalizer
by connecting the GK port to the desired transformation or target and using the values
Normalizing Data in a Mapping 241
ranging from 1 to 2147483647. At the end of each session, the PowerCenter Server updates
the GK value to the last value generated for the session plus one.
If you have multiple versions of the Normalizer transformation, the PowerCenter Server
updates the GK value across all versions when it runs a session.
If you open the mapping after you run the session, the current value displays the last value
generated for the session plus one. Since the PowerCenter Server uses the GK value to
determine the first value for each session, you should only edit the GK value if you want to
reset the sequence.
If you have multiple versions of the Normalizer, and you want to reset the sequence, you must
check in the mapping after you modify the GK value.
Generated Column ID
The Designer generates a port for each OCCURS clause to specify the positional index within
an OCCURS clause. You can use the generated column ID to create a primary-foreign key
relationship. The naming convention for the Normalizer generated column ID is:
GCID_<occuring_field_name>
As shown in Figure 10-1 on page 243, the Designer adds one column (GCID_HST_MTH
and GCID_HST_AMT) for each OCCURS in the COBOL source. The Normalizer GCID
columns tell you the order of records in an OCCURS clause. For example, if a record occurs
two times, when you run the workflow, the PowerCenter Server numbers the first record 1
and the second record 2.
Adding a COBOL Source to a Mapping
When you add a COBOL source to a mapping, the Mapping Designer inserts and configures
a Normalizer transformation. The Normalizer transformation identifies the nested records
within the COBOL source and displays them accordingly.
To add a COBOL source to a mapping:
1. In the Designer, create a new mapping or open an existing one.
2. Click and drag an imported COBOL source definition into the mapping.
If the Designer does not create a Normalizer transformation by default, manually create
the Normalizer transformation.
For example, when you add the COBOL source to a mapping, the Designer adds a
Normalizer transformation and connects it to the COBOL source definition.
242 Chapter 10: Normalizer Transformation
Figure 10-1 illustrates that the ports representing HST_MTH appear separately within
the Normalizer transformation:
Figure 10-1. COBOL Source Definition and a Normalizer Transformation
If you connect the ports directly from the Normalizer transformation to targets, you
connect the records from HST_MTH, represented in the Normalizer transformation, to
their own target definition, distinct from any other target that may appear in the
mapping.
3. Open the new Normalizer transformation.
4. Select the Ports tab and review the ports in the Normalizer transformation.
5. Click the Normalizer tab to review the original organization of the COBOL source.
This tab contains the same information as in the Columns tab of the source definition for
this COBOL source. However, you cannot modify the field definitions in the Normalizer
transformation. If you need to make modifications, open the source definition in the
Source Analyzer.
6. Select the Properties tab and enter the following settings:
Setting Description
Reset Resets the generated key value after the session finishes to its original value.
Restart Restarts the generated key values from 1 every time you run a session.
Tracing level Determines the amount of information about this transformation that the PowerCenter Server
writes to the session log. You can override this tracing level when you configure a session.
7. Click OK.
8. Connect the Normalizer transformation to the rest of the mapping.
If you have denormalized data for which the Normalizer transformation has created key
values, connect the ports representing the repeated data and the output port for the generated
Normalizing Data in a Mapping 243
keys to a different portion of the data flow in the mapping. Ultimately, you may want to write
these values to different targets.
To add a Normalizer transformation to a mapping:
1. In the Mapping Designer, choose Transformation-Create. Select Normalizer
transformation. Enter a name for the Normalizer transformation. Click Create.
The naming convention for Normalizer transformations is NRM_TransformationName.
The Designer creates the Normalizer transformation.
If your mapping contains a COBOL source, and you do not have the option set to
automatically create a source qualifier, the Create Normalizer Transformation dialog box
displays. For more information about this option, see “Using the Designer” in the
Designer Guide.
2. If the create Normalizer Transformation dialog box displays, select the Normalizer
transformation type.
3. Select the source for this transformation. Click OK.
4. Open the new Normalizer transformation.
5. Select the Normalizer tab and add new output ports.
Add a port corresponding to each column in the source record that contains
denormalized data. The new ports only allow the number or string datatypes. You can
create only new ports in the Normalizer tab, not the Ports tab.
Using the level controls in the Normalizer transformation, identify which ports belong to
the master and detail records. Adjust these ports so that the level setting for detail ports is
higher than the level setting for the master record. For example, if ports from the master
record are at level 1, the detail ports are at level 2. When you adjust the level setting for
the first detail port, the Normalizer transformation creates a heading for the detail record.
Enter the number of times detail records repeat within each master record.
6. After configuring the output ports, click Apply.
244 Chapter 10: Normalizer Transformation
The Normalizer transformation creates all the input and output ports needed to connect
master and detail records to the rest of the mapping. In addition, the Normalizer
transformation creates a generated key column for joining master and detail records.
When you run a session, the PowerCenter Server generates unique IDs for these columns.
7. Select the Properties tab and enter the following settings:
Setting Description
Reset Reset generated key sequence values at the end of the session.
Restart Start the generated key sequence values from 1.
Tracing level Determines the amount of information PowerCenter Server writes to the session log.
You can override this tracing level when you configure a session.
8. Click OK.
9. Connect the Normalizer transformation to the rest of the mapping.
10. Choose Repository-Save.
Normalizing Data in a Mapping 245
Differences Between Normalizer Transformations
There are a number of differences between a VSAM Normalizer transformation using
COBOL sources and a pipeline Normalizer transformation.
Table 10-1 lists the differences between Normalizer transformations:
Table 10-1. VSAM and Relational Normalizer Transformation Differences
VSAM Normalizer Transformation Pipeline Normalizer Transformation
Connection COBOL source Any transformation
Port creation Automatically created based on the Created manually
COBOL source
Ni-or-1 rule Yes Yes
Transformations allowed No Yes
before the Normalizer
transformation
Transformations allowed Yes Yes
after the Normalizer
Transformation
Reusable No Yes
Ports Input/Output Input/Output
Note: Concatenation from the Normalizer transformation occurs only when the row sets being
concatenated are of the order one. You cannot concatenate row sets in which the order is
greater than one.
246 Chapter 10: Normalizer Transformation
Troubleshooting
I cannot edit the ports in my Normalizer transformation when using a relational source.
When you create ports manually, you must do so on the Normalizer tab in the
transformation, not the Ports tab.
Importing a COBOL file failed with a lot of errors. What should I do?
Check your file heading to see if it follows the COBOL standard, including spaces, tabs, and
end of line characters. The header should be similar to the following:
identification division.
program-id. mead.
environment division.
select file-one assign to "fname".
data division.
file section.
fd FILE-ONE.
The import parser does not handle hidden characters or extra spacing very well. Be sure to use
a text-only editor to make changes to the COBOL file, such as the DOS edit command. Do
not use Notepad or Wordpad.
A session that reads binary data completed, but the information in the target table is
incorrect.
Open the session in the Workflow Manager, edit the session, and check the source file format
to see if the EBCDIC/ASCII is set correctly. The number of bytes to skip between records
must be set to 0.
I have a COBOL field description that uses a non-IBM COMP type. How should I import
the source?
In the source definition, clear the IBM COMP option.
In my mapping, I use one Expression transformation and one Lookup transformation to
modify two output ports from the Normalizer transformation. The mapping concatenates
them into one single transformation. All the ports are under the same level, which does not
violate the Ni-or-1 rule. When I check the data loaded in the target, it is incorrect. Why is
that?
You can only concatenate ports from level one. Remove the concatenation.
Troubleshooting 247
248 Chapter 10: Normalizer Transformation
Chapter 11
Rank Transformation
This chapter includes the following topics:
♦ Overview, 250
♦ Ports in a Rank Transformation, 252
♦ Defining Groups, 253
♦ Creating a Rank Transformation, 254
249
Overview
Transformation type:
Active
Connected
The Rank transformation allows you to select only the top or bottom rank of data. You can
use a Rank transformation to return the largest or smallest numeric value in a port or group.
You can also use a Rank transformation to return the strings at the top or the bottom of a
session sort order. During the session, the PowerCenter Server caches input data until it can
perform the rank calculations.
The Rank transformation differs from the transformation functions MAX and MIN, in that it
allows you to select a group of top or bottom values, not just one value. For example, you can
use Rank to select the top 10 salespersons in a given territory. Or, to generate a financial
report, you might also use a Rank transformation to identify the three departments with the
lowest expenses in salaries and overhead. While the SQL language provides many functions
designed to handle groups of data, identifying top or bottom strata within a set of rows is not
possible using standard SQL functions.
You connect all ports representing the same row set to the transformation. Only the rows that
fall within that rank, based on some measure you set when you configure the transformation,
pass through the Rank transformation. You can also write expressions to transform data or
perform calculations.
Figure 11-1 shows a mapping that passes employee data from a human resources table
through a Rank transformation. The Rank only passes the rows for the top 10 highest paid
employees to the next transformation.
Figure 11-1. Sample Mapping with a Rank Transformation
As an active transformation, the Rank transformation might change the number of rows
passed through it. You might pass 100 rows to the Rank transformation, but select to rank
only the top 10 rows, which pass from the Rank transformation to another transformation.
You can connect ports from only one transformation to the Rank transformation. The Rank
transformation allows you to create local variables and write non-aggregate expressions.
250 Chapter 11: Rank Transformation
Ranking String Values
When the PowerCenter Server runs in the ASCII data movement mode, it sorts session data
using a binary sort order.
When the PowerCenter Server runs in Unicode data movement mode, the PowerCenter
Server uses the sort order configured for the session. You select the session sort order in the
session properties. The session properties lists all available sort orders based on the code page
used by the PowerCenter Server.
For example, you have a Rank transformation configured to return the top three values of a
string port. When you configure the workflow, you select the PowerCenter Server on which
you want the workflow to run. The session properties display all sort orders associated with
the code page of the selected PowerCenter Server, such as French, German, and Binary. If you
configure the session to use a binary sort order, the PowerCenter Server calculates the binary
value of each string, and returns the three rows with the highest binary values for the string.
Rank Caches
During a session, the PowerCenter Server compares an input row with rows in the data cache.
If the input row out-ranks a cached row, the PowerCenter Server replaces the cached row with
the input row. If you configure the Rank transformation to rank across multiple groups, the
PowerCenter Server ranks incrementally for each group it finds.
The PowerCenter Server stores group information in an index cache and row data in a data
cache. If you create multiple partitions in a pipeline, the PowerCenter Server creates separate
caches for each partition. For more information about caching, see “Session Caches” in the
Workflow Administration Guide.
Rank Transformation Properties
When you create a Rank transformation, you can configure the following properties:
♦ Enter a cache directory.
♦ Select the top or bottom rank.
♦ Select the input/output port that contains values used to determine the rank. You can
select only one port to define a rank.
♦ Select the number of rows falling within a rank.
♦ Define groups for ranks, such as the 10 least expensive products for each manufacturer.
Overview 251
Ports in a Rank Transformation
The Rank transformation includes input or input/output ports connected to another
transformation in the mapping. It also includes variable ports and a rank port. Use the rank
port to specify the column you want to rank.
Table 11-1 lists the ports in a Rank transformation:
Table 11-1. Rank Transformation Ports
Ports Number Required Description
I Minimum of one Input port. Create an input port to receive data from another transformation.
O Minimum of one Output port. Create an output port for each port you want to link to another
transformation. You can designate input ports as output ports.
V Not Required Variable port. Can use to store values or calculations to use in an
expression. Variable ports cannot be input or output ports. They pass data
within the transformation only.
R One only Rank port. Use to designate the column for which you want to rank values.
You can designate only one Rank port in a Rank transformation. The Rank
port is an input/output port. You must link the Rank port to another
transformation.
Rank Index
The Designer automatically creates a RANKINDEX port for each Rank transformation. The
PowerCenter Server uses the Rank Index port to store the ranking position for each row in a
group. For example, if you create a Rank transformation that ranks the top five salespersons
for each quarter, the rank index numbers the salespeople from 1 to 5:
RANKINDEX SALES_PERSON SALES
1 Sam 10,000
2 Mary 9,000
3 Alice 8,000
4 Ron 7,000
5 Alex 6,000
The RANKINDEX is an output port only. You can pass the rank index to another
transformation in the mapping or directly to a target.
252 Chapter 11: Rank Transformation
Defining Groups
Like the Aggregator transformation, the Rank transformation allows you to group
information. For example, if you want to select the 10 most expensive items by manufacturer,
you would first define a group for each manufacturer. When you configure the Rank
transformation, you can set one of its input/output ports as a group by port. For each unique
value in the group port (for example, MANUFACTURER_ID or
MANUFACTURER_NAME), the transformation creates a group of rows falling within the
rank definition (top or bottom, and a particular number in each rank).
Therefore, the Rank transformation changes the number of rows in two different ways. By
filtering all but the rows falling within a top or bottom rank, you reduce the number of rows
that pass through the transformation. By defining groups, you create one set of ranked rows
for each group.
For example, you might create a Rank transformation to identify the 50 highest paid
employees in the company. In this case, you would identify the SALARY column as the input/
output port used to measure the ranks, and configure the transformation to filter out all rows
except the top 50.
After the Rank transformation identifies all rows that belong to a top or bottom rank, it then
assigns rank index values. In the case of the top 50 employees, measured by salary, the highest
paid employee receives a rank index of 1. The next highest-paid employee receives a rank
index of 2, and so on. When measuring a bottom rank, such as the 10 lowest priced products
in your inventory, the Rank transformation assigns a rank index from lowest to highest.
Therefore, the least expensive item would receive a rank index of 1.
If two rank values match, they receive the same value in the rank index and the
transformation skips the next value. For example, if you want to see the top five retail stores in
the country and two stores have the same sales, the return data might look similar to the
following:
RANKINDEX SALES STORE
1 10000 Orange
1 10000 Brea
3 90000 Los Angeles
4 80000 Ventura
Defining Groups 253
Creating a Rank Transformation
You can add a Rank transformation anywhere in the mapping after the source qualifier.
To create a Rank transformation:
1. In the Mapping Designer, choose Transformation-Create. Select the Rank
transformation. Enter a name for the Rank. The naming convention for Rank
transformations is RNK_TransformationName.
Enter a description for the transformation. This description appears in the Repository
Manager.
2. Click Create, and then click Done.
The Designer creates the Rank transformation.
3. Link columns from an input transformation to the Rank transformation.
4. Click the Ports tab, and then select the Rank (R) option for the port used to measure
ranks.
If you want to create groups for ranked rows, select Group By for the port that defines
the group.
254 Chapter 11: Rank Transformation
5. Click the Properties tab and select whether you want the top or bottom rank.
For the Number of Ranks option, enter the number of rows you want to select for the
rank.
Change the following properties, if necessary:
Setting Description
Cache Directory Local directory where the PowerCenter Server creates the index
and data cache files. By default, the PowerCenter Server uses the
directory entered in the Workflow Manager for the server variable
$PMCacheDir. If you enter a new directory, make sure the directory
exists and contains enough disk space for the cache files.
Top/Bottom Specifies whether you want the top or bottom ranking for a column.
Number of Ranks The number of rows you want to rank.
Case-Sensitive String Comparison When running in Unicode mode, the PowerCenter Server ranks
strings based on the sort order selected for the session. If the
session sort order is case-sensitive, select this option to enable
case-sensitive string comparisons, and clear this option to have
the PowerCenter Server ignore case for strings. If the sort order is
not case-sensitive, the PowerCenter Server ignores this setting. By
default, this option is selected.
Tracing Level Determines the amount of information the PowerCenter Server
writes to the session log about data passing through this
transformation in a session.
Rank Data Cache Size Data cache size for the transformation. Default is 2,000,000 bytes.
If the total configured session cache size is 2 GB (2,147,483,648
bytes) or more, you must run the session on a 64-bit PowerCenter
Server.
Creating a Rank Transformation 255
Setting Description
Rank Index Cache Size Index cache size for the transformation. Default is 1,000,000 bytes.
If the total configured session cache size is 2 GB (2,147,483,648
bytes) or more, you must run the session on a 64-bit PowerCenter
Server.
Transformation Scope Specifies how the PowerCenter Server applies the transformation
logic to incoming data:
- Transaction. Applies the transformation logic to all rows in a
transaction. Choose Transaction when a row of data depends on
all rows in the same transaction, but does not depend on rows in
other transactions.
- All Input. Applies the transformation logic on all incoming data.
When you choose All Input, the PowerCenter drops incoming
transaction boundaries. Choose All Input when a row of data
depends on all rows in the source.
For more information about transformation scope, see
“Understanding Commit Points” in the Workflow Administration
Guide.
6. Click OK to return to the Designer.
7. Choose Repository-Save.
256 Chapter 11: Rank Transformation
Chapter 12
Router Transformation
This chapter covers the following topics:
♦ Overview, 258
♦ Working with Groups, 260
♦ Working with Ports, 264
♦ Connecting Router Transformations in a Mapping, 266
♦ Creating a Router Transformation, 268
257
Overview
Transformation type:
Connected
Active
A Router transformation is similar to a Filter transformation because both transformations
allow you to use a condition to test data. A Filter transformation tests data for one condition
and drops the rows of data that do not meet the condition. However, a Router transformation
tests data for one or more conditions and gives you the option to route rows of data that do
not meet any of the conditions to a default output group.
If you need to test the same input data based on multiple conditions, use a Router
transformation in a mapping instead of creating multiple Filter transformations to perform
the same task. The Router transformation is more efficient. For example, to test data based on
three conditions, you only need one Router transformation instead of three filter
transformations to perform this task. Likewise, when you use a Router transformation in a
mapping, the PowerCenter Server processes the incoming data only once. When you use
multiple Filter transformations in a mapping, the PowerCenter Server processes the incoming
data for each transformation.
Figure 12-1 illustrates two mappings that perform the same task. Mapping A uses three Filter
transformations while Mapping B produces the same result with one Router transformation:
Figure 12-1. Comparing Router and Filter Transformations
Mapping A Mapping B
A Router transformation consists of input and output groups, input and output ports, group
filter conditions, and properties that you configure in the Designer.
258 Chapter 12: Router Transformation
Figure 12-2 illustrates a sample Router transformation and its components:
Figure 12-2. Sample Router Transformation
Input Ports Input Group
User-Defined
Output Groups Output Ports
Default Output Group
Overview 259
Working with Groups
A Router transformation has the following types of groups:
♦ Input
♦ Output
Input Group
The Designer copies property information from the input ports of the input group to create a
set of output ports for each output group.
Output Groups
There are two types of output groups:
♦ User-defined groups
♦ Default group
You cannot modify or delete output ports or their properties.
User-Defined Groups
You create a user-defined group to test a condition based on incoming data. A user-defined
group consists of output ports and a group filter condition. The Designer allows you to create
and edit user-defined groups on the Groups tab. Create one user-defined group for each
condition that you want to specify.
The PowerCenter Server uses the condition to evaluate each row of incoming data. It tests the
conditions of each user-defined group before processing the default group. The PowerCenter
Server determines the order of evaluation for each condition based on the order of the
connected output groups. The PowerCenter Server processes user-defined groups that are
connected to a transformation or a target in a mapping. The PowerCenter Server only
processes user-defined groups that are not connected in a mapping if the default group is
connected to a transformation or a target.
If a row meets more than one group filter condition, the PowerCenter Server passes this row
multiple times.
The Default Group
The Designer creates the default group after you create one new user-defined group. The
Designer does not allow you to edit or delete the default group. This group does not have a
group filter condition associated with it. If all of the conditions evaluate to FALSE, the
PowerCenter Server passes the row to the default group. If you want the PowerCenter Server
260 Chapter 12: Router Transformation
to drop all rows in the default group, do not connect it to a transformation or a target in a
mapping.
The Designer deletes the default group when you delete the last user-defined group from the
list.
Using Group Filter Conditions
You can test data based on one or more group filter conditions. You create group filter
conditions on the Groups tab using the Expression Editor. You can enter any expression that
returns a single value. You can also specify a constant for the condition. A group filter
condition returns TRUE or FALSE for each row that passes through the transformation,
depending on whether a row satisfies the specified condition. Zero (0) is the equivalent of
FALSE, and any non-zero value is the equivalent of TRUE. The PowerCenter Server passes
the rows of data that evaluate to TRUE to each transformation or target that is associated
with each user-defined group.
For example, you have customers from nine countries, and you want to perform different
calculations on the data from only three countries. You might want to use a Router
transformation in a mapping to filter this data to three different Expression transformations.
There is no group filter condition associated with the default group. However, you can create
an Expression transformation to perform a calculation based on the data from the other six
countries.
Figure 12-3 illustrates a mapping with a Router transformation that filters data based on
multiple conditions:
Figure 12-3. Using a Router Transformation in a Mapping
Working with Groups 261
Since you want to perform multiple calculations based on the data from three different
countries, create three user-defined groups and specify three group filter conditions on the
Groups tab.
Figure 12-4 illustrates specifying group filter conditions in a Router transformation to filter
customer data:
Figure 12-4. Specifying Group Filter Conditions
In the session, the PowerCenter Server passes the rows of data that evaluate to TRUE to each
transformation or target that is associated with each user-defined group, such as Japan,
France, and USA. The PowerCenter Server passes the row to the default group if all of the
conditions evaluate to FALSE. If this happens, the PowerCenter Server passes the data of the
other six countries to the transformation or target that is associated with the default group. If
you want the PowerCenter Server to drop all rows in the default group, do not connect it to a
transformation or a target in a mapping.
Adding Groups
Adding a group is similar to adding a port in other transformations. The Designer copies
property information from the input ports to the output ports. For details, see “Working with
Groups” on page 260.
To add a group to a Router transformation:
1. Click the Groups tab.
2. Click the Add button.
3. Enter a name for the new group in the Group Name section.
4. Click the Group Filter Condition field and open the Expression Editor.
262 Chapter 12: Router Transformation
5. Enter the group filter condition.
6. Click Validate to check the syntax of the condition.
7. Click OK.
Working with Groups 263
Working with Ports
A Router transformation has input ports and output ports. Input ports are in the input group,
and output ports are in the output groups. You can create input ports by copying them from
another transformation or by manually creating them on the Ports tab.
Figure 12-5 illustrates the Ports tab of a Router transformation:
Figure 12-5. Router Transformation Ports Tab
The Designer creates output ports by copying the following properties from the input ports:
♦ Port name
♦ Datatype
♦ Precision
♦ Scale
♦ Default value
When you make changes to the input ports, the Designer updates the output ports to reflect
these changes. You cannot edit or delete output ports. The output ports display in the Normal
view of the Router transformation.
The Designer creates output port names based on the input port names. For each input port,
the Designer creates a corresponding output port in each output group.
264 Chapter 12: Router Transformation
Figure 12-6 illustrates the output port names of a Router transformation in Normal view,
which correspond to the input port names:
Figure 12-6. Input Port Name and Corresponding Output Port Names
Input Port Name
Corresponding
Output Port
Names
Working with Ports 265
Connecting Router Transformations in a Mapping
When you connect transformations to a Router transformation in a mapping, consider the
following rules:
♦ You can connect one group to one transformation or target.
Output Group 1
Port 1
Port 2 Port 1
Port 3 Port 2
Output Group 2 Port 3
Port 1 Port 4
Port 2
Port 3
♦ You can connect one output port in a group to multiple transformations or targets.
Output Group 1
Port 1 Port 1
Port 2 Port 2
Port 3 Port 3
Output Group 2 Port 4
Port 1
Port 2 Port 1
Port 3 Port 2
Port 3
Port 4
♦ You can connect multiple output ports in one group to multiple transformations or targets.
Output Group 1
Port 1 Port 1
Port 2 Port 2
Port 3 Port 3
Output Group 2 Port 4
Port 1
Port 2 Port 1
Port 3 Port 2
Port 3
Port 4
♦ You cannot connect more than one group to one target or a single input group
transformation.
Output Group 1
Port 1 Port 1
Port 2 Port 2
Port 3 Port 3
Output Group 2 Port 4
Port 1
Port 2
Port 3
266 Chapter 12: Router Transformation
♦ You can connect more than one group to a multiple input group transformation, except for
Joiner transformations, when you connect each output group to a different input group.
Output Group 1 Input Group 1
Port 1 Port 1
Port 2 Port 2
Port 3 Port 3
Output Group 2 Input Group 2
Port 1 Port 1
Port 2 Port 2
Port 3 Port 3
Connecting Router Transformations in a Mapping 267
Creating a Router Transformation
To add a Router transformation to a mapping, complete the following steps.
To create a Router transformation:
1. In the Mapping Designer, open a mapping.
2. Choose Transformation-Create.
Select Router transformation, and enter the name of the new transformation. The
naming convention for the Router transformation is RTR_TransformationName. Click
Create, and then click Done.
3. Select and drag all the desired ports from a transformation to add them to the Router
transformation, or you can manually create input ports on the Ports tab.
4. Double-click the title bar of the Router transformation to edit transformation properties.
5. Click the Transformation tab and configure transformation properties as desired.
6. Click the Properties tab and configure tracing levels as desired.
For more information about configuring tracing levels, see “Transformations” in the
Designer Guide.
7. Click the Groups tab, and then click the Add button to create a user-defined group.
The Designer creates the default group when you create the first user-defined group.
8. Click the Group Filter Condition field to open the Expression Editor.
9. Enter a group filter condition.
10. Click Validate to check the syntax of the conditions you entered.
11. Click OK.
12. Connect group output ports to transformations or targets.
13. Choose Repository-Save.
268 Chapter 12: Router Transformation
Chapter 13
Sequence Generator
Transformation
This chapter covers the following topics:
♦ Overview, 270
♦ Common Uses, 271
♦ Sequence Generator Ports, 272
♦ Transformation Properties, 275
♦ Creating a Sequence Generator Transformation, 280
269
Overview
Transformation type:
Passive
Connected
The Sequence Generator transformation generates numeric values. You can use the Sequence
Generator to create unique primary key values, replace missing primary keys, or cycle through
a sequential range of numbers.
The Sequence Generator transformation is a connected transformation. It contains two
output ports that you can connect to one or more transformations. The PowerCenter Server
generates a block of sequence numbers each time a block of rows enters a connected
transformation. If you connect CURRVAL, the PowerCenter Server processes one row in each
block. When NEXTVAL is connected to the input port of another transformation, the
PowerCenter Server generates a sequence of numbers. When CURRVAL is connected to the
input port of another transformation, the PowerCenter Server generates the NEXTVAL value
plus the Increment By value.
You can make a Sequence Generator reusable, and use it in multiple mappings. You might
reuse a Sequence Generator when you perform multiple loads to a single target.
For example, if you have a large input file that you separate into three sessions running in
parallel, you can use a Sequence Generator to generate primary key values. If you use different
Sequence Generators, the PowerCenter Server might generate duplicate key values. Instead,
you can use the reusable Sequence Generator for all three sessions to provide a unique value
for each target row.
270 Chapter 13: Sequence Generator Transformation
Common Uses
You can perform the following tasks with a Sequence Generator transformation:
♦ Create keys.
♦ Replace missing values.
♦ Cycle through a sequential range of numbers.
Creating Keys
You can create approximately two billion primary or foreign key values with the Sequence
Generator transformation by connecting the NEXTVAL port to the desired transformation or
target and using the widest range of values (1 to 2147483647) with the smallest interval (1).
When creating primary or foreign keys, only use the Cycle option to prevent the PowerCenter
Server from creating duplicate primary keys. You might do this by selecting the Truncate
Target Table option in the session properties (if appropriate) or by creating composite keys.
To create a composite key, you can configure the PowerCenter Server to cycle through a
smaller set of values. For example, if you have three stores generating order numbers, you
might have a Sequence Generator cycling through values from 1 to 3, incrementing by 1.
When you pass the following set of foreign keys, the generated values then create unique
composite keys:
COMPOSITE_KEY ORDER_NO
1 12345
2 12345
3 12345
1 12346
2 12346
3 12346
Replacing Missing Values
Use the Sequence Generator transformation to replace missing keys by using NEXTVAL with
the IIF and ISNULL functions.
To replace null values in the ORDER_NO column, for example, you create a Sequence
Generator transformation with the desired properties and drag the NEXTVAL port to an
Expression transformation. In the Expression transformation, drag the ORDER_NO port
into the transformation (along with any other necessary ports). Then create a new output
port, ALL_ORDERS.
In ALL_ORDERS, you can then enter the following expression to replace null orders:
IIF( ISNULL( ORDER_NO ), NEXTVAL, ORDER_NO )
Common Uses 271
Sequence Generator Ports
The Sequence Generator transformation provides two output ports: NEXTVAL and
CURRVAL. You cannot edit or delete these ports. Likewise, you cannot add ports to the
transformation.
NEXTVAL
Connect NEXTVAL to multiple transformations to generate unique values for each row in
each transformation. Use the NEXTVAL port to generate sequence numbers by connecting it
to a transformation or target. You connect the NEXTVAL port to a downstream
transformation to generate the sequence based on the Current Value and Increment By
properties. For more information about Sequence Generator properties, see Table 13-1 on
page 275.
For example, you might connect NEXTVAL to two target tables in a mapping to generate
unique primary key values. The PowerCenter Server creates a column of unique primary key
values for each target table. The column of unique primary key values is sent to one target
table as a block of sequence numbers. The second targets receives a block of sequence
numbers from the Sequence Generator transformation only after the first target table receives
the block of sequence numbers.
Figure 13-1 illustrates connecting NEXTVAL to two target tables in a mapping:
Figure 13-1. Connecting NEXTVAL to Two Target Tables in a Mapping
For example, you configure the Sequence Generator transformation as follows: Current Value
= 1, Increment By = 1. When you run the workflow, the PowerCenter Server generates the
following primary key values for the T_ORDERS_PRIMARY and T_ORDERS_FOREIGN
target tables:
T_ORDERS_PRIMARY TABLE: T_ORDERS_FOREIGN TABLE:
PRIMARY KEY PRIMARY KEY
1 6
2 7
3 8
272 Chapter 13: Sequence Generator Transformation
T_ORDERS_PRIMARY TABLE: T_ORDERS_FOREIGN TABLE:
PRIMARY KEY PRIMARY KEY
4 9
5 10
If you want the same values to go to more than one target that receives data from a single
transformation, you can connect a Sequence Generator transformation to that preceding
transformation. The PowerCenter Server Sequence Generator transformation processes the
values into a block of sequence numbers. This allows the PowerCenter Server to pass unique
values to the transformation, and then route rows from the transformation to targets.
Figure 13-2 illustrates a mapping with a the Sequence Generator that passes unique values to
the Expression transformation. The Expression transformation then populates both targets
with identical primary key values.
Figure 13-2. Mapping With a Sequence Generator and an Expression Transformation
For example, you configure the Sequence Generator transformation as follows: Current Value
= 1, Increment By = 1. When you run the workflow, the PowerCenter Server generates the
following primary key values for the T_ORDERS_PRIMARY and T_ORDERS_FOREIGN
target tables:
T_ORDERS_PRIMARY TABLE: T_ORDERS_FOREIGN TABLE:
PRIMARY KEY PRIMARY KEY
1 1
2 2
3 3
4 4
5 5
CURRVAL
CURRVAL is NEXTVAL plus the Increment By value. You typically only connect the
CURRVAL port when the NEXTVAL port is already connected to a downstream
Sequence Generator Ports 273
transformation. When a row enters the transformation connected to the CURRVAL port, the
PowerCenter Server passes the last-created NEXTVAL value plus one.
For details on the Increment By value, see “Increment By” on page 276.
Figure 13-3 illustrates connecting CURRVAL and NEXTVAL ports to a target:
Figure 13-3. Connecting CURRVAL and NEXTVAL Ports to a Target
For example, you configure the Sequence Generator transformation as follows: Current Value
= 1, Increment By = 1. When you run the workflow, the PowerCenter Server generates the
following values for NEXTVAL and CURRVAL:
NEXTVAL CURRVAL
1 2
2 3
3 4
4 5
5 6
If you connect the CURRVAL port without connecting the NEXTVAL port, the
PowerCenter Server passes a constant value for each row.
Note: When you connect the CURRVAL port in a Sequence Generator transformation, the
Informatica Server processes one row in each block. You can optimize performance by
connecting only the NEXTVAL port in a mapping.
274 Chapter 13: Sequence Generator Transformation
Transformation Properties
The Sequence Generator transformation is unique among all transformations because you
cannot add, edit, or delete its default ports (NEXTVAL and CURRVAL).
Table 13-1 lists the Sequence Generator transformation properties you can configure:
Table 13-1. Sequence Generator Transformation Properties
Sequence Generator
Description
Setting
Start Value The start value of the generated sequence that you want the PowerCenter
Server to use if you use the Cycle option. If you select Cycle, the
PowerCenter Server cycles back to this value when it reaches the end
value.
The default value is 0.
Increment By The difference between two consecutive values from the NEXTVAL port.
The default value is 1.
End Value The maximum value the PowerCenter Server generates. If the PowerCenter
Server reaches this value during the session and the sequence is not
configured to cycle, it fails the session.
Current Value The current value of the sequence. Enter the value you want the
PowerCenter Server to use as the first value in the sequence. If you want to
cycle through a series of values, the value must be greater than or equal to
the start value and less than the end value.
If the Number of Cached Values is set to 0, the PowerCenter Server
updates the current value to reflect the last-generated value for the session
plus one, and then uses the updated current value as the basis for the next
time you run this session. However, if you use the Reset option, the
PowerCenter Server resets this value to its original value after each
session.
Note: If you edit this setting, you reset the sequence to the new setting. If
you reset Current Value to 10, and the increment is 1, the next time you use
the session, the PowerCenter Server generates a first value of 10.
Cycle If selected, the PowerCenter Server cycles through the sequence range.
Otherwise, the PowerCenter Server stops the sequence at the configured
end value.
If disabled, the PowerCenter Server fails the session with overflow errors if
it reaches the end value and still has rows to process.
Number of Cached Values The number of sequential values the PowerCenter Server caches at a time.
Use this option when multiple sessions use the same reusable Sequence
Generator at the same time to ensure each session receives unique values.
The PowerCenter Server updates the repository as it caches each value.
When set to 0, the PowerCenter Server does not cache values.
The default value for a standard Sequence Generator is 0.
The default value for a reusable Sequence Generator is 1,000.
Transformation Properties 275
Table 13-1. Sequence Generator Transformation Properties
Sequence Generator
Description
Setting
Reset If selected, the PowerCenter Server generates values based on the original
current value for each session. Otherwise, the PowerCenter Server updates
the current value to reflect the last-generated value for the session plus
one, and then uses the updated current value as the basis for the next
session run.
This option is disabled for reusable Sequence Generator transformations.
Tracing Level Level of detail about the transformation that the PowerCenter Server writes
into the session log.
Start Value and Cycle
You can use Cycle to generate a repeating sequence, such as numbers 1 through 12 to
correspond to the months in a year.
To cycle the PowerCenter Server through a sequence:
1. Enter the lowest value in the sequence that you want the PowerCenter Server to use for
the Start Value.
2. Then enter the highest value to be used for End Value.
3. Select Cycle.
As it cycles, the PowerCenter Server reaches the configured end value for the sequence, it
wraps around and starts the cycle again, beginning with the configured Start Value.
Increment By
The PowerCenter Server generates a sequence (NEXTVAL) based on the Current Value and
Increment By properties in the Sequence Generator transformation.
The Current Value property is the value at which the PowerCenter Server starts creating the
sequence for each session. Increment By is the integer the PowerCenter Server adds to the
existing value to create the new value in the sequence. By default, the Current Value is set to
1, and Increment By is set to 1.
For example, you might create a Sequence Generator transformation with a current value of
1,000 and an increment of 10. If you pass three rows through the mapping, the PowerCenter
Server generates the following set of values:
1000
1010
1020
276 Chapter 13: Sequence Generator Transformation
End Value
End Value is the maximum value you want the PowerCenter Server to generate. If the
PowerCenter Server reaches the end value and the Sequence Generator is not configured to
cycle through the sequence, the session fails with the following error message:
TT_11009 Sequence Generator Transformation: Overflow error.
You can set the end value to any integer between 1 and 2147483647.
Current Value
The PowerCenter Server uses the current value as the basis for generated values for each
session. To indicate which value you want the PowerCenter Server to use the first time it uses
the Sequence Generator transformation, you must enter that value as the current value. If you
want to use the Sequence Generator transformation to cycle through a series of values, the
current value must be greater than or equal to Start Value and less than the end value.
At the end of each session, the PowerCenter Server updates the current value to the last value
generated for the session plus one if the Sequence Generator Number of Cached Values is 0.
For example, if the PowerCenter Server ends a session with a generated value of 101, it
updates the Sequence Generator current value to 102 in the repository. The next time the
Sequence Generator is used, the PowerCenter Server uses 102 as the basis for the next
generated value. If the Sequence Generator Increment By is 1, when the PowerCenter Server
starts another session using the Sequence Generator, the first generated value is 102.
If you have multiple versions of the Sequence Generator transformation, the PowerCenter
Server updates the current value across all versions when it runs a session.
If you open the mapping after you run the session, the current value displays the last value
generated for the session plus one. Since the PowerCenter Server uses the current value to
determine the first value for each session, you should only edit the current value when you
want to reset the sequence.
If you have multiple versions of the Sequence Generator transformation, and you want to
reset the sequence, you must check in the mapping or Sequence Generator (reusable)
transformation after you modify the current value.
Note: If you configure the Sequence Generator to Reset, the PowerCenter Server uses the
current value as the basis for the first generated value for each session.
Number of Cached Values
Number of Cached Values determines the number of values the PowerCenter Server caches at
one time. When Number of Cached Values is greater than zero, the PowerCenter Server
caches the configured number of values and updates the current value each time it caches
values.
When multiple sessions use the same reusable Sequence Generator transformation at the same
time, there might be multiple instances of the Sequence Generator transformation. To avoid
Transformation Properties 277
generating the same values for each session, reserve a range of sequence values for each session
by configuring Number of Cached Values.
Non-Reusable Sequence Generators
For non-reusable Sequence Generator transformations, Number of Cached Values is set to
zero by default, and the PowerCenter Server does not cache values during the session. When
the PowerCenter Server does not cache values, it accesses the repository for the current value
at the start of a session. The PowerCenter Server then generates values for the sequence as
necessary. At the end of the session, the PowerCenter Server updates the current value in the
repository.
When you set Number of Cached Values greater than zero, the PowerCenter Server caches
values during the session. At the start of the session, the PowerCenter Server accesses the
repository for the current value, caches the configured number of values, and updates the
current value accordingly. If the PowerCenter Server exhausts the cache, it accesses the
repository for the next set of values and updates the current value. At the end of the session,
the PowerCenter Server discards any remaining values in the cache.
For non-reusable Sequence Generator transformations, setting Number of Cached Values
greater than zero can increase the number of times the PowerCenter Server accesses the
repository during the session. It also causes sections of skipped values since unused cached
values are discarded at the end of each session.
For example, you configure a Sequence Generator transformation as follows: Number of
Cached Values = 50, Current Value = 1, Increment By = 1. When the PowerCenter Server
starts the session, it caches 50 values for the session and updates the current value to 50 in the
repository. The PowerCenter Server uses values 1 to 39 for the session and discards the unused
values, 40 to 49. When the PowerCenter Server runs the session again, it checks the
repository for the current value, which is 50. It then caches the next 50 values and updates the
current value to 100. During the session, it uses values 50 to 98. The values generated for the
two sessions are 1 to 39 and 50 to 98.
Reusable Sequence Generators
When you have a reusable Sequence Generator transformation in several sessions and the
sessions run at the same time, use Number of Cached Values to ensure each session receives
unique values in the sequence. By default, Number of Cached Values is set to 1000 for
reusable Sequence Generators.
When multiple sessions use the same Sequence Generator transformation at the same time,
you risk generating the same values for each session. To avoid this, have the PowerCenter
Server cache a set number of values for each session by configuring Number of Cached Values.
For example, you configure a reusable Sequence Generator transformation as follows:
Number of Cached Values = 50, Current Value = 1, Increment By = 1. Two sessions use the
Sequence Generator, and they are scheduled to run at approximately the same time. When the
PowerCenter Server starts the first session, it caches 50 values for the session and updates the
current value to 50 in the repository. The PowerCenter Server begins using values 1 to 50 in
the session. When the PowerCenter Server starts the second session, it checks the repository
278 Chapter 13: Sequence Generator Transformation
for the current value, which is 50. It then caches the next 50 values and updates the current
value to 100. It then uses values 51 to 100 in the second session. When either session uses all
its cached values, the PowerCenter Server caches a new set of values and updates the current
value to ensure these values remain unique to the Sequence Generator.
For reusable Sequence Generator transformations, you can reduce Number of Cached Values
to minimize discarded values, however it must be greater than one. Note, when you reduce
the Number of Cached Values, you might increase the number of times the PowerCenter
Server accesses the repository to cache values during the session.
Reset
If you select Reset for a non-reusable Sequence Generator transformation, the PowerCenter
Server generates values based on the original current value each time it starts the session.
Otherwise, the PowerCenter Server updates the current value to reflect the last-generated
value plus one, and then uses the updated value the next time it uses the Sequence Generator
transformation.
For example, you might configure a Sequence Generator transformation to create values from
1 to 1,000 with an increment of 1, and a current value of 1 and choose Reset. During the first
session run, the PowerCenter Server generates numbers 1 through 234. The next time (and
each subsequent time) the session runs, the PowerCenter Server again generates numbers
beginning with the current value of 1.
If you do not select Reset, the PowerCenter Server updates the current value to 235 at the end
of the first session run. The next time it uses the Sequence Generator transformation, the first
value generated is 235.
Note: Reset is disabled for reusable Sequence Generator transformations.
Transformation Properties 279
Creating a Sequence Generator Transformation
To use a Sequence Generator transformation in a mapping, add it to the mapping, configure
the transformation properties, and then connect NEXTVAL or CURRVAL to one or more
transformations.
To create a Sequence Generator transformation:
1. In the Mapping Designer, select Transformation-Create. Select the Sequence Generator
transformation.
The naming convention for Sequence Generator transformations is
SEQ_TransformationName.
2. Enter a name for the Sequence Generator, and click Create. Click Done.
The Designer creates the Sequence Generator transformation.
3. Double-click the title bar of the transformation to open the Edit Transformations dialog
box.
4. Enter a description for the transformation. This description appears in the Repository
Manager, making it easier for you or others to understand what the transformation does.
5. Select the Properties tab. Enter settings as necessary.
For a list of transformation properties, see Table 13-1 on page 275.
280 Chapter 13: Sequence Generator Transformation
Note: You cannot override the Sequence Generator transformation properties at the
session level. This protects the integrity of the sequence values generated.
6. Click OK.
7. To generate new sequences during a session, connect the NEXTVAL port to at least one
transformation in the mapping.
You can use the NEXTVAL or CURRVAL ports in an expression in other
transformations.
8. Choose Repository-Save.
Creating a Sequence Generator Transformation 281
282 Chapter 13: Sequence Generator Transformation
Chapter 14
Sorter Transformation
This chapter covers the following topics:
♦ Overview, 284
♦ Sorting Data, 285
♦ Sorter Transformation Properties, 287
♦ Creating a Sorter Transformation, 291
283
Overview
Transformation type:
Connected
Active
The Sorter transformation allows you to sort data. You can sort data in ascending or
descending order according to a specified sort key. You can also configure the Sorter
transformation for case-sensitive sorting, and specify whether the output rows should be
distinct. The Sorter transformation is an active transformation. It must be connected to the
data flow.
You can sort data from relational or flat file sources. You can also use the Sorter
transformation to sort data passing through an Aggregator transformation configured to use
sorted input.
When you create a Sorter transformation in a mapping, you specify one or more ports as a
sort key and configure each sort key port to sort in ascending or descending order. You also
configure sort criteria the PowerCenter Server applies to all sort key ports and the system
resources it allocates to perform the sort operation.
Figure 14-1 illustrates a simple mapping that uses a Sorter transformation. The mapping
passes rows from a sales table containing order information through a Sorter transformation
before loading to the target.
Figure 14-1. Sample Mapping with a Sorter Transformation
284 Chapter 14: Sorter Transformation
Sorting Data
The Sorter transformation contains only input/output ports. All data passing through the
Sorter transformation is sorted according to a sort key. The sort key is one or more ports that
you want to use as the sort criteria.
You can specify more than one port as part of the sort key. When you specify multiple ports
for the sort key, the PowerCenter Server sorts each port sequentially. The order the ports
appear in the Ports tab determines the succession of sort operations. The Sorter
transformation treats the data passing through each successive sort key port as a secondary
sort of the previous port.
At session run time, the PowerCenter Server sorts data according to the sort order specified in
the session properties. The sort order determines the sorting criteria for special characters and
symbols.
Figure 14-2 shows the Ports tab configuration for the Sorter transformation sorting the data
in ascending order by order ID and item ID:
Figure 14-2. Sample Sorter Transformation Ports Configuration
At session run time, the PowerCenter Server passes the following rows into the Sorter
transformation:
ORDER_ID ITEM_ID QUANTITY DISCOUNT
45 123456 3 3.04
45 456789 2 12.02
43 000246 6 34.55
41 000468 5 .56
Sorting Data 285
After sorting the data, the PowerCenter Server passes the following rows out of the Sorter
transformation:
ORDER_ID ITEM_ID QUANTITY DISCOUNT
41 000468 5 .56
43 000246 6 34.55
45 123456 3 3.04
45 456789 2 12.02
286 Chapter 14: Sorter Transformation
Sorter Transformation Properties
The Sorter transformation has several properties that specify additional sort criteria. The
PowerCenter Server applies these criteria to all sort key ports. The Sorter transformation
properties also determine the system resources the PowerCenter Server allocates when it sorts
data.
Figure 14-3 illustrates the Sorter transformation Properties tab:
Figure 14-3. Sorter Transformation Properties
Sorter Cache Size
The PowerCenter Server uses the Sorter Cache Size property to determine the maximum
amount of memory it can allocate to perform the sort operation. The PowerCenter Server
passes all incoming data into the Sorter transformation before it performs the sort operation.
You can specify any amount between 1 MB and 4 GB for the Sorter cache size. If the total
configured session cache size is 2 GB (2,147,483,648 bytes) or greater, you must run the
session on a 64-bit PowerCenter Server.
Before starting the sort operation, the PowerCenter Server allocates the amount of memory
configured for the Sorter cache size. If the PowerCenter Server runs a partitioned session, it
allocates the specified amount of Sorter cache memory for each partition.
If it cannot allocate enough memory, the PowerCenter Server fails the session. For best
performance, configure Sorter cache size with a value less than or equal to the amount of
available physical RAM on the PowerCenter Server machine. Informatica recommends
allocating at least 8 MB (8,388,608 bytes) of physical memory to sort data using the Sorter
transformation. Sorter cache size is set to 8,388,608 bytes by default.
Sorter Transformation Properties 287
If the amount of incoming data is greater than the amount of Sorter cache size, the
PowerCenter Server temporarily stores data in the Sorter transformation work directory. The
PowerCenter Server requires disk space of at least twice the amount of incoming data when
storing data in the work directory. If the amount of incoming data is significantly greater than
the Sorter cache size, the PowerCenter Server may require much more than twice the amount
of disk space available to the work directory.
Use the following formula to determine the size of incoming data:
# input rows [( Σ column size) + 16]
Table 14-1 gives the individual column size values by datatype for Sorter data calculations:
Table 14-1. Column Sizes for Sorter Data Calculations
Datatype Column Size
Binary precision + 8
Round to nearest multiple of 8
Date/Time 24
Decimal, high precision off (all precision) 16
Decimal, high precision on (precision <=18) 24
Decimal, high precision on (precision >18, <=28) 32
Decimal, high precision on (precision >28) 16
Decimal, high precision on (negative scale) 16
Double 16
Real 16
Integer 16
Small integer 16
NString, NText, String, Text Unicode mode: 2*(precision + 5)
ASCII mode: precision + 9
The column sizes include the bytes required for a null indicator.
To increase performance for the sort operation, the PowerCenter Server aligns all data for the
Sorter transformation memory on an eight-byte boundary. Each Sorter column includes
rounding to the nearest multiple of eight.
The PowerCenter Server also writes the row size and amount of memory the Sorter
transformation uses to the session log when you configure the Sorter transformation tracing
level to Normal. For more information about Sorter transformation tracing levels, see
“Tracing Level” on page 289.
288 Chapter 14: Sorter Transformation
Case Sensitive
The Case Sensitive property determines whether the PowerCenter Server considers case when
sorting data. When you enable the Case Sensitive property, the PowerCenter Server sorts
uppercase characters higher than lowercase characters.
Work Directory
You must specify a work directory the PowerCenter Server uses to create temporary files while
it sorts data. After the PowerCenter Server sorts the data, it deletes the temporary files. You
can specify any directory on the PowerCenter Server machine to use as a work directory. By
default, the PowerCenter Server uses the value specified for the $PMTempDir server variable.
When you partition a session with a Sorter transformation, you can specify a different work
directory for each partition in the pipeline. To increase session performance, specify work
directories on physically separate disks on the PowerCenter Server system.
Distinct Output Rows
You can configure the Sorter transformation to treat output rows as distinct. If you configure
the Sorter transformation for distinct output rows, the Mapping Designer configures all ports
as part of the sort key. When the PowerCenter Server runs the session, it discards duplicate
rows compared during the sort operation.
Tracing Level
Configure the Sorter transformation tracing level to control the number and type of Sorter
error and status messages the PowerCenter Server writes to the session log. At Normal tracing
level, the PowerCenter Server writes the size of the row passed to the Sorter transformation
and the amount of memory the Sorter transformation allocates for the sort operation. The
PowerCenter Server also writes the time and date when it passes the first and last input rows
to the Sorter transformation.
If you configure the Sorter transformation tracing level to Verbose Data, the PowerCenter
Server writes the time the Sorter transformation finishes passing all data to the next
transformation in the pipeline. The PowerCenter Server also writes the time to the session log
when the Sorter transformation releases memory resources and removes temporary files from
the work directory.
For more information about configuring tracing levels for transformations, see
“Transformations” in the Designer Guide.
Sorter Transformation Properties 289
Null Treated Low
You can configure the way the Sorter transformation treats null values. Enable this property if
you want the PowerCenter Server to treat null values as lower than any other value when it
performs the sort operation. Disable this option if you want the PowerCenter Server to treat
null values as higher than any other value.
Transformation Scope
The transformation scope specifies how the PowerCenter Server applies the transformation
logic to incoming data:
♦ Transaction. Applies the transformation logic to all rows in a transaction. Choose
Transaction when a row of data depends on all rows in the same transaction, but does not
depend on rows in other transactions.
♦ All Input. Applies the transformation logic on all incoming data. When you choose All
Input, the PowerCenter drops incoming transaction boundaries. Choose All Input when a
row of data depends on all rows in the source.
For more information about transformation scope, see “Understanding Commit Points” in
the Workflow Administration Guide.
290 Chapter 14: Sorter Transformation
Creating a Sorter Transformation
To add a Sorter transformation to a mapping, complete the following steps.
To create a Sorter transformation:
1. In the Mapping Designer, choose Transformation-Create. Select the Sorter
transformation.
The naming convention for Sorter transformations is SRT_TransformationName. Enter a
description for the transformation. This description appears in the Repository Manager,
making it easier to understand what the transformation does.
2. Enter a name for the Sorter and click Create.
The Designer creates the Sorter transformation.
3. Click Done.
4. Drag the ports you want to sort into the Sorter transformation.
The Designer creates the input/output ports for each port you include.
5. Double-click the title bar of the transformation to open the Edit Transformations dialog
box.
6. Select the Ports tab.
7. Select the ports you want to use as the sort key.
8. For each port selected as part of the sort key, specify whether you want the PowerCenter
Server to sort data in ascending or descending order.
9. Select the Properties tab. Modify the Sorter transformation properties as needed. For
details on Sorter transformation properties, see “Sorter Transformation Properties” on
page 287.
10. Select the Metadata Extensions tab. Create or edit metadata extensions for the Sorter
transformation. For more information about metadata extensions, see “Metadata
Extensions” in the Repository Guide.
11. Click OK.
12. Choose Repository-Save to save changes to the mapping.
Creating a Sorter Transformation 291
292 Chapter 14: Sorter Transformation
Chapter 15
Source Qualifier
Transformation
This chapter covers the following topics:
♦ Overview, 294
♦ Default Query, 297
♦ Joining Source Data, 299
♦ Adding an SQL Query, 303
♦ Entering a User-Defined Join, 305
♦ Outer Join Support, 307
♦ Entering a Source Filter, 315
♦ Using Sorted Ports, 317
♦ Select Distinct, 319
♦ Adding Pre- and Post-Session SQL Commands, 320
♦ Creating a Source Qualifier Transformation, 321
♦ Troubleshooting, 323
293
Overview
Transformation type:
Active
Connected
When you add a relational or a flat file source definition to a mapping, you need to connect it
to a Source Qualifier transformation. The Source Qualifier transformation represents the
rows that the PowerCenter Server reads when it runs a session.
You can use the Source Qualifier transformation to perform the following tasks:
♦ Join data originating from the same source database. You can join two or more tables
with primary key-foreign key relationships by linking the sources to one Source Qualifier
transformation.
♦ Filter rows when the PowerCenter Server reads source data. If you include a filter
condition, the PowerCenter Server adds a WHERE clause to the default query.
♦ Specify an outer join rather than the default inner join. If you include a user-defined
join, the PowerCenter Server replaces the join information specified by the metadata in the
SQL query.
♦ Specify sorted ports. If you specify a number for sorted ports, the PowerCenter Server
adds an ORDER BY clause to the default SQL query.
♦ Select only distinct values from the source. If you choose Select Distinct, the
PowerCenter Server adds a SELECT DISTINCT statement to the default SQL query.
♦ Create a custom query to issue a special SELECT statement for the PowerCenter Server
to read source data. For example, you might use a custom query to perform aggregate
calculations.
Transformation Datatypes
The Source Qualifier transformation displays the transformation datatypes. The
transformation datatypes determine how the source database binds data when the
PowerCenter Server reads it. Do not alter the datatypes in the Source Qualifier
transformation. If the datatypes in the source definition and Source Qualifier transformation
do not match, the Designer marks the mapping invalid when you save it.
Target Load Order
You specify a target load order based on the Source Qualifier transformations in a mapping. If
you have multiple Source Qualifier transformations connected to multiple targets, you can
designate the order in which the PowerCenter Server loads data into the targets.
294 Chapter 15: Source Qualifier Transformation
If one Source Qualifier transformation provides data for multiple targets, you can enable
constraint-based loading in a session to have the PowerCenter Server load data based on target
table primary and foreign key relationships.
For more information, see “Mappings” in the Designer Guide.
Parameters and Variables
You can use mapping parameters and variables in the SQL query, user-defined join, and
source filter of a Source Qualifier transformation. You can also use the system variable
$$$SessStartTime.
The PowerCenter Server first generates an SQL query and replaces each mapping parameter
or variable with its start value. Then it runs the query on the source database.
When you use a string mapping parameter or variable in the Source Qualifier transformation,
use a string identifier appropriate to the source system. Most databases use a single quotation
mark as a string identifier. For example, to use the string parameter $$IPAddress in a source
filter for a Microsoft SQL Server database table, enclose the parameter in single quotes as
follows, ‘$$IPAddress’. See your database documentation for details.
When you use a datetime mapping parameter or variable, or when you use the system variable
$$$SessStartTime, you might need to change the date format to the format used in the
source. The PowerCenter Server passes datetime parameters and variables to source systems as
strings in the SQL query. The PowerCenter Server converts a datetime parameter or variable
to a string, based on the source database.
Table 15-1 describes the datetime formats the PowerCenter Server uses for each source
system:
Table 15-1. Conversion for Datetime Mapping Parameters and Variables
Source Date Format
DB2 YYYY-MM-DD-HH24:MI:SS
Informix YYYY-MM-DD HH24:MI:SS
Microsoft SQL Server MM/DD/YYYY HH24:MI:SS
ODBC YYYY-MM-DD HH24:MI:SS
Oracle MM/DD/YYYY HH24:MI:SS
Sybase MM/DD/YYYY HH24:MI:SS
Teradata YYYY-MM-DD HH24:MI:SS
Some databases require you to identify datetime values with additional punctuation, such as
single quotation marks or database specific functions. For example, to convert the
$$$SessStartTime value for an Oracle source, use the following Oracle function in the SQL
override:
to_date (‘$$$SessStartTime’, ‘mm/dd/yyyy hh24:mi:ss’)
Overview 295
For Informix, you can use the following Informix function in the SQL override to convert the
$$$SessStartTime value:
DATETIME ($$$SessStartTime) YEAR TO SECOND
For more information about SQL override, see “Overriding the Default Query” on page 298.
For details on database specific functions, see your database documentation.
Tip: To ensure the format of a datetime parameter or variable matches that used by the source,
validate the SQL query.
For details on mapping parameters and variables, see “Mapping Parameters and Variables” in
the Designer Guide.
296 Chapter 15: Source Qualifier Transformation
Default Query
For relational sources, the PowerCenter Server generates a query for each Source Qualifier
transformation when it runs a session. The default query is a SELECT statement for each
source column used in the mapping. In other words, the PowerCenter Server reads only the
columns that are connected to another transformation.
Figure 15-1 shows a single source definition connected to a Source Qualifier transformation:
Figure 15-1. Source Definition Connected to a Source Qualifier Transformation
Although there are many columns in the source definition, only three columns are connected
to another transformation. In this case, the PowerCenter Server generates a default query that
selects only those three columns:
SELECT CUSTOMERS.CUSTOMER_ID, CUSTOMERS.COMPANY, CUSTOMERS.FIRST_NAME
FROM CUSTOMERS
If any table name or column name contains a database reserved word, you can create and
maintain a file, reswords.txt, containing reserved words. When the PowerCenter Server
initializes a session, it searches for reswords.txt in the PowerCenter Server installation
directory. If the file exists, the PowerCenter Server places quotes around matching reserved
words when it executes SQL against the database. If you override the SQL, you must enclose
any reserved word in quotes. For more information about the reserved words file, see
“Working with Targets” in the Workflow Administration Guide.
When generating the default query, the Designer delimits table and field names containing
the following characters with double quotes:
/ + - = ~ ` ! % ^ & * ( ) [ ] { } ' ; ? , < > \ | <space>
Viewing the Default Query
You can view the default query in the Source Qualifier transformation.
To view the default query:
1. From the Properties tab, select SQL Query.
Default Query 297
The SQL Editor displays.
2. Click Generate SQL.
The SQL Editor displays the default query the PowerCenter Server uses to select source
data.
3. Click Cancel to exit.
Note: If you do not cancel the SQL query, the PowerCenter Server overrides the default query
with the custom SQL query.
Do not connect to the source database. You only connect to the source database when you
enter an SQL query that overrides the default query.
Tip: You must connect the columns in the Source Qualifier transformation to another
transformation or target before you can generate the default query.
Overriding the Default Query
You can alter or override the default query in the Source Qualifier transformation by changing
the default settings of the transformation properties. Do not change the list of selected ports
or the order in which they appear in the query. This list must match the connected
transformation output ports.
When you edit transformation properties, the Source Qualifier transformation includes these
settings in the default query. However, if you enter an SQL query, the PowerCenter Server
uses only the defined SQL statement. The SQL Query overrides the User-Defined Join,
Source Filter, Number of Sorted Ports, and Select Distinct settings in the Source Qualifier
transformation.
Note: When you override the default SQL query, you must enclose all database reserved words
in quotes.
298 Chapter 15: Source Qualifier Transformation
Joining Source Data
You can use one Source Qualifier transformation to join data from multiple relational tables.
These tables must be accessible from the same instance or database server.
When a mapping uses related relational sources, you can join both sources in one Source
Qualifier transformation. During the session, the source database performs the join before
passing data to the PowerCenter Server. This can increase performance when source tables are
indexed.
Tip: Use the Joiner transformation for heterogeneous sources and to join flat files.
Default Join
When you join related tables in one Source Qualifier transformation, the PowerCenter Server
joins the tables based on the related keys in each table.
This default join is an inner equijoin, using the following syntax in the WHERE clause:
Source1.column_name = Source2.column_name
The columns in the default join must have:
♦ A primary key-foreign key relationship
♦ Matching datatypes
For example, you might see all the orders for the month, including order number, order
amount, and customer name. The ORDERS table includes the order number and amount of
each order, but not the customer name. To include the customer name, you need to join the
ORDERS and CUSTOMERS tables. Both tables include a customer ID, so you can join the
tables in one Source Qualifier transformation.
Joining Source Data 299
Figure 15-2 illustrates joining two tables with one Source Qualifier transformation:
Figure 15-2. Joining Two Tables With One Source Qualifier Transformation
When you include multiple tables, the PowerCenter Server generates a SELECT statement for
all columns used in the mapping. In this case, the SELECT statement looks similar to the
following statement:
SELECT CUSTOMERS.CUSTOMER_ID, CUSTOMERS.COMPANY, CUSTOMERS.FIRST_NAME,
CUSTOMERS.LAST_NAME, CUSTOMERS.ADDRESS1, CUSTOMERS.ADDRESS2,
CUSTOMERS.CITY, CUSTOMERS.STATE, CUSTOMERS.POSTAL_CODE, CUSTOMERS.PHONE,
CUSTOMERS.EMAIL, ORDERS.ORDER_ID, ORDERS.DATE_ENTERED,
ORDERS.DATE_PROMISED, ORDERS.DATE_SHIPPED, ORDERS.EMPLOYEE_ID,
ORDERS.CUSTOMER_ID, ORDERS.SALES_TAX_RATE, ORDERS.STORE_ID
FROM CUSTOMERS, ORDERS
WHERE CUSTOMERS.CUSTOMER_ID=ORDERS.CUSTOMER_ID
The WHERE clause is an equijoin that includes the CUSTOMER_ID from the ORDERS
and CUSTOMER tables.
Custom Joins
If you need to override the default join, you can enter contents of the WHERE clause that
specifies the join in the custom query.
You might need to override the default join under the following circumstances:
♦ Columns do not have a primary key-foreign key relationship.
♦ The datatypes of columns used for the join do not match.
300 Chapter 15: Source Qualifier Transformation
♦ You want to specify a different type of join, such as an outer join.
For more information about custom joins and queries, see “Entering a User-Defined Join” on
page 305.
Heterogeneous Joins
To perform a heterogeneous join, use the Joiner transformation. Use the Joiner
transformation when you need to join the following types of sources:
♦ Join data from different source databases
♦ Join data from different flat file systems
♦ Join relational sources and flat files
For more information, see “Joiner Transformation” on page 155.
Creating Key Relationships
You can join tables in the Source Qualifier transformation if the tables have primary key-
foreign key relationships. However, you can create primary key-foreign key relationships in
the Source Analyzer by linking matching columns in different tables. These columns do not
have to be keys, but they should be included in the index for each table.
Tip: If the source table has more than 1000 rows, you can increase performance by indexing
the primary key-foreign keys. If the source table has fewer than 1000 rows, you might
decrease performance if you index the primary key-foreign keys.
For example, the corporate office for a retail chain wants to extract payments received based
on orders. The ORDERS and PAYMENTS tables do not share primary and foreign keys.
Both tables, however, include a DATE_SHIPPED column. You can create a primary key-
foreign key relationship in the metadata in the Source Analyzer.
Note, the two tables are not linked. Therefore, the Designer does not recognize the
relationship on the DATE_SHIPPED columns.
You create a relationship between the ORDERS and PAYMENTS tables by linking the
DATE_SHIPPED columns. The Designer automatically adds primary and foreign keys to the
DATE_SHIPPED columns in the ORDERS and PAYMENTS table definitions.
Figure 15-3 shows a relationship between two tables:
Figure 15-3. Creating a Relationship Between Two Tables
Joining Source Data 301
If you do not connect the columns, the Designer does not recognize the relationships.
The primary key-foreign key relationships exist in the metadata only. You do not need to
generate SQL or alter the source tables.
Once the key relationships exist, you can use a Source Qualifier transformation to join the
two tables. The default join is based on DATE_SHIPPED.
302 Chapter 15: Source Qualifier Transformation
Adding an SQL Query
The Source Qualifier transformation provides the SQL Query option to override the default
query. You can enter an SQL statement supported by your source database. Before entering
the query, connect all the input and output ports you want to use in the mapping.
When you edit the SQL Query, you can generate and edit the default query. When the
Designer generates the default query, it incorporates all other configured options, such as a
filter or number of sorted ports. The resulting query overrides all other options you might
subsequently configure in the transformation.
You can include mapping parameters and variables in the SQL Query. When including a
string mapping parameter or variable, use a string identifier appropriate to the source system.
For most databases, you should enclose the name of a string parameter or variable in single
quotes. See your database documentation for details.
When you include a datetime parameter or variable, you might need to change the date
format to match the format used by the source. The PowerCenter Server converts a datetime
parameter and variable to a string based on the source system. For more information about
date conversion, see Table 15-1 on page 295.
When creating a custom SQL query, the SELECT statement must list the port names in the
order in which they appear in the transformation.
If you edit the SQL query, you must enclose all database reserved words in quotes. For more
information about reserved words, see “Working with Targets” in the Workflow Administration
Guide.
To override the default query:
1. Open the Source Qualifier transformation, and click the Properties tab.
2. Click the Open button in the SQL Query field. The SQL Editor dialog box appears.
3. Click Generate SQL.
The Designer displays the default query it generates when querying rows from all sources
included in the Source Qualifier transformation.
4. Enter your own query in the space where the default query appears.
Every column name must be qualified by the name of the table, view, or synonym in
which it appears. For example, if you want to include the ORDER_ID column from the
ORDERS table, enter ORDERS.ORDER_ID. You can double-click column names
appearing in the Ports window to avoid typing the name of every column.
Enclose string mapping parameters and variables in string identifiers. Alter the date
format for datetime mapping parameters and variables when necessary.
5. Select the ODBC data source containing the sources included in the query.
6. Enter the user name and password to connect to this database.
Adding an SQL Query 303
7. Click Validate.
The Designer runs the query and reports whether its syntax was correct.
8. Click OK to return to the Edit Transformations dialog box. Click OK again to return to
the Designer.
9. Choose Repository-Save.
Tip: You can resize the Expression Editor. Expand the dialog box by dragging from the
borders. The Designer saves the new size for the dialog box as a client setting.
304 Chapter 15: Source Qualifier Transformation
Entering a User-Defined Join
Entering a user-defined join is similar to entering a custom SQL query. However, you only
enter the contents of the WHERE clause, not the entire query.
When you add a user-defined join, the Source Qualifier transformation includes the setting in
the default SQL query. However, if you modify the default query after adding a user-defined
join, the PowerCenter Server uses only the query defined in the SQL Query property of the
Source Qualifier transformation.
You can include mapping parameters and variables in a user-defined join. When including a
string mapping parameter or variable, use a string identifier appropriate to the source system.
For most databases, you should enclose the name of a string parameter or variable in single
quotes. See your database documentation for details.
When you include a datetime parameter or variable, you might need to change the date
format to match the format used by the source. The PowerCenter Server converts a datetime
parameter and variable to a string based on the source system. For more information about
automatic date conversion, see Table 15-1 on page 295.
To create a user-defined join:
1. Create a Source Qualifier transformation containing data from multiple sources or
associated sources.
2. Open the Source Qualifier transformation, and click the Properties tab.
3. Click the Open button in the User Defined Join field. The SQL Editor dialog box
appears.
4. Enter the syntax for the join.
Do not enter the keyword WHERE at the beginning of the join. The PowerCenter Server
adds this keyword when it queries rows.
Entering a User-Defined Join 305
Enclose string mapping parameters and variables in string identifiers. Alter the date
format for datetime mapping parameters and variables when necessary.
5. Click OK to return to the Edit Transformations dialog box, and then click OK to return
to the Designer.
6. Choose Repository-Save.
306 Chapter 15: Source Qualifier Transformation
Outer Join Support
You can use the Source Qualifier and the Application Source Qualifier transformations to
perform an outer join of two sources in the same database. When the PowerCenter Server
performs an outer join, it returns all rows from one source table and rows from the second
source table that match the join condition.
Use an outer join when you want to join two tables and return all rows from one of the tables.
For example, you might perform an outer join when you want to join a table of registered
customers with a monthly purchases table to determine registered customer activity. Using an
outer join, you can join the registered customer table with the monthly purchases table and
return all rows in the registered customer table, including customers who did not make
purchases in the last month. If you perform a normal join, the PowerCenter Server returns
only registered customers who made purchases during the month, and only purchases made
by registered customers.
With an outer join, you can generate the same results as a master outer or detail outer join in
the Joiner transformation. However, when you use an outer join, you reduce the number of
rows in the data flow. This can improve performance.
The PowerCenter Server supports two kinds of outer joins:
♦ Left. PowerCenter Server returns all rows for the table to the left of the join syntax and the
rows from both tables that meet the join condition.
♦ Right. PowerCenter Server returns all rows for the table to the right of the join syntax and
the rows from both tables that meet the join condition.
Note: You can use outer joins in nested query statements when you override the default query.
Informatica Join Syntax
When you enter join syntax, you can use Informatica or database-specific join syntax. When
you use the Informatica join syntax, the PowerCenter Server translates the syntax and passes it
to the source database during the session.
Note: Always use database-specific syntax for join conditions.
When you use Informatica join syntax, enclose the entire join statement in braces
({Informatica syntax}). When you use database syntax, enter syntax supported by the source
database without braces.
When using Informatica join syntax, use table names to prefix column names. For example, if
you have a column named FIRST_NAME in the REG_CUSTOMER table, enter
“REG_CUSTOMER.FIRST_NAME” in the join syntax. Also, when using an alias for a table
name, use the alias within the Informatica join syntax to ensure the PowerCenter Server
recognizes the alias.
Outer Join Support 307
Table 15-2 lists the join syntax you can enter, in different locations for different Source
Qualifier transformations, when you create an outer join:
Table 15-2. Locations for Entering Outer Join Syntax
Transformation Transformation Setting Description
Source Qualifier User-Defined Join Create a join override. During the session, the
transformation PowerCenter Server appends the join override to the
WHERE clause of the default query.
SQL Query Enter join syntax immediately after the WHERE in the
default query.
Application Source Join Override Create a join override. During the session, the
Qualifier transformation PowerCenter Server appends the join override to the
WHERE clause of the default query.
Extract Override Enter join syntax immediately after the WHERE in the
default query.
You can combine left outer and right outer joins with normal joins in a single source qualifier.
You can use multiple normal joins and multiple left outer joins.
When you combine joins, enter them in the following order:
1. Normal
2. Left outer
3. Right outer
Note: Some databases limit you to using one right outer join.
Normal Join Syntax
You can create a normal join using the join condition in a source qualifier. However, if you are
creating an outer join, you need to override the default join to perform an outer join. As a
result, you need to include the normal join in the join override. When incorporating a normal
join in the join override, list the normal join before outer joins. You can enter multiple
normal joins in the join override.
To create a normal join, use the following syntax:
{ source1 INNER JOIN source2 on join_condition }
Table 15-3 displays the syntax for Normal Joins in a Join Override:
Table 15-3. Syntax for Normal Joins in a Join Override
Syntax Description
source1 Source table name. PowerCenter Server returns rows from this table that match the join
condition.
308 Chapter 15: Source Qualifier Transformation
Table 15-3. Syntax for Normal Joins in a Join Override
Syntax Description
source2 Source table name. PowerCenter Server returns rows from this table that match the join
condition.
join_condition Condition for the join. Use syntax supported by the source database. You can combine
multiple join conditions with the AND operator.
For example, you have a REG_CUSTOMER table with data for registered customers:
CUST_ID FIRST_NAME LAST_NAME
00001 Marvin Chi
00002 Dinah Jones
00003 John Bowden
00004 J. Marks
The PURCHASES table, refreshed monthly, contains the following data:
TRANSACTION_NO CUST_ID DATE AMOUNT
06-2000-0001 00002 6/3/2000 55.79
06-2000-0002 00002 6/10/2000 104.45
06-2000-0003 00001 6/10/2000 255.56
06-2000-0004 00004 6/15/2000 534.95
06-2000-0005 00002 6/21/2000 98.65
06-2000-0006 NULL 6/23/2000 155.65
06-2000-0007 NULL 6/24/2000 325.45
To return rows displaying customer names for each transaction in the month of June, use the
following syntax:
{ REG_CUSTOMER INNER JOIN PURCHASES on REG_CUSTOMER.CUST_ID =
PURCHASES.CUST_ID }
The PowerCenter Server returns the following data:
CUST_ID DATE AMOUNT FIRST_NAME LAST_NAME
00002 6/3/2000 55.79 Dinah Jones
00002 6/10/2000 104.45 Dinah Jones
00001 6/10/2000 255.56 Marvin Chi
00004 6/15/2000 534.95 J. Marks
00002 6/21/2000 98.65 Dinah Jones
The PowerCenter Server returns rows with matching customer IDs. It does not include
customers who made no purchases in June. It also does not include purchases made by non-
registered customers.
Outer Join Support 309
Left Outer Join Syntax
You can create a left outer join with a join override. You can enter multiple left outer joins in
a single join override. When using left outer joins with other joins, list all left outer joins
together, after any normal joins in the statement.
To create a left outer join, use the following syntax:
{ source1 LEFT OUTER JOIN source2 on join_condition }
Table 15-4 displays syntax for left outer joins in a join override:
Table 15-4. Syntax for Left Outer Joins in a Join Override
Syntax Description
source1 Source table name. With a left outer join, the PowerCenter Server returns all rows in this
table.
source2 Source table name. PowerCenter Server returns rows from this table that match the join
condition.
join_condition Condition for the join. Use syntax supported by the source database. You can combine
multiple join conditions with the AND operator.
For example, using the same REG_CUSTOMER and PURCHASES tables described in
“Normal Join Syntax” on page 308, you can determine how many customers bought
something in June with the following join override:
{ REG_CUSTOMER LEFT OUTER JOIN PURCHASES on REG_CUSTOMER.CUST_ID =
PURCHASES.CUST_ID }
The PowerCenter Server returns the following data:
CUST_ID FIRST_NAME LAST_NAME DATE AMOUNT
00001 Marvin Chi 6/10/2000 255.56
00002 Dinah Jones 6/3/2000 55.79
00003 John Bowden NULL NULL
00004 J. Marks 6/15/2000 534.95
00002 Dinah Jones 6/10/2000 104.45
00002 Dinah Jones 6/21/2000 98.65
The PowerCenter Server returns all registered customers in the REG_CUSTOMERS table,
using null values for the customer who made no purchases in June. It does not include
purchases made by non-registered customers.
You can use multiple join conditions to determine how many registered customers spent more
than $100.00 in a single purchase in June:
{REG_CUSTOMER LEFT OUTER JOIN PURCHASES on (REG_CUSTOMER.CUST_ID =
PURCHASES.CUST_ID AND PURCHASES.AMOUNT > 100.00) }
310 Chapter 15: Source Qualifier Transformation
The PowerCenter Server returns the following data:
CUST_ID FIRST_NAME LAST_NAME DATE AMOUNT
00001 Marvin Chi 6/10/2000 255.56
00002 Dinah Jones 6/10/2000 104.45
00003 John Bowden NULL NULL
00004 J. Marks 6/15/2000 534.95
You might use multiple left outer joins if you want to incorporate information about returns
during the same time period. For example, your RETURNS table contains the following data:
CUST_ID CUST_ID RETURN
00002 6/10/2000 55.79
00002 6/21/2000 104.45
To determine how many customers made purchases and returns for the month of June, you
can use two left outer joins:
{ REG_CUSTOMER LEFT OUTER JOIN PURCHASES on REG_CUSTOMER.CUST_ID =
PURCHASES.CUST_ID LEFT OUTER JOIN RETURNS on REG_CUSTOMER.CUST_ID =
PURCHASES.CUST_ID }
The PowerCenter Server returns the following data:
CUST_ID FIRST_NAME LAST_NAME DATE AMOUNT RET_DATE RETURN
00001 Marvin Chi 6/10/2000 255.56 NULL NULL
00002 Dinah Jones 6/3/2000 55.79 NULL NULL
00003 John Bowden NULL NULL NULL NULL
00004 J. Marks 6/15/2000 534.95 NULL NULL
00002 Dinah Jones 6/10/2000 104.45 NULL NULL
00002 Dinah Jones 6/21/2000 98.65 NULL NULL
00002 Dinah Jones NULL NULL 6/10/2000 55.79
00002 Dinah Jones NULL NULL 6/21/2000 104.45
The PowerCenter Server uses NULLs for missing values.
Right Outer Join Syntax
You can create a right outer join with a join override. The right outer join returns the same
results as a left outer join if you reverse the order of the tables in the join syntax. Use only one
right outer join in a join override. If you want to create more than one right outer join, try
reversing the order of the source tables and changing the join types to left outer joins.
When you use a right outer join with other joins, enter the right outer join at the end of the
join override.
Outer Join Support 311
To create a right outer join, use the following syntax:
{ source1 RIGHT OUTER JOIN source2 on join_condition }
Table 15-5 displays syntax for right outer joins in a join override:
Table 15-5. Syntax for Right Outer Joins in a Join Override
Syntax Description
source1 Source table name. PowerCenter Server returns rows from this table that match the join
condition.
source2 Source table name. With a right outer join, the PowerCenter Server returns all rows in this
table.
join_condition Condition for the join. Use syntax supported by the source database. You can combine
multiple join conditions with the AND operator.
You might use a right outer join with a left outer join to join and return all data from both
tables, simulating a full outer join. For example, you can extract all registered customers and
all purchases for the month of June with the following join override:
{REG_CUSTOMER LEFT OUTER JOIN PURCHASES on REG_CUSTOMER.CUST_ID =
PURCHASES.CUST_ID RIGHT OUTER JOIN PURCHASES on REG_CUSTOMER.CUST_ID =
PURCHASES.CUST_ID }
The PowerCenter Server returns the following data:
CUST_ID FIRST_NAME LAST_NAME TRANSACTION_NO DATE AMOUNT
00001 Marvin Chi 06-2000-0003 6/10/2000 255.56
00002 Dinah Jones 06-2000-0001 6/3/2000 55.79
00003 John Bowden NULL NULL NULL
00004 J. Marks 06-2000-0004 6/15/2000 534.95
00002 Dinah Jones 06-2000-0002 6/10/2000 104.45
00002 Dinah Jones 06-2000-0005 6/21/2000 98.65
NULL NULL NULL 06-2000-0006 6/23/2000 155.65
NULL NULL NULL 06-2000-0007 6/24/2000 325.45
Creating an Outer Join
You can enter an outer join as a join override or as part of an override of the default query.
When you create a join override, the Designer appends the join override to the WHERE
clause of the default query. During the session, the PowerCenter Server translates the
Informatica join syntax and includes it in the default query used to extract source data. When
possible, enter a join override instead of overriding the default query.
When you override the default query, enter the join syntax in the WHERE clause of the
default query. During the session, the PowerCenter Server translates Informatica join syntax
and then uses the query to extract source data. If you make changes to the transformation
312 Chapter 15: Source Qualifier Transformation
after creating the override, the PowerCenter Server ignores the changes. Therefore, when
possible, enter outer join syntax as a join override.
To create an outer join as a join override:
1. Open the Source Qualifier transformation, and click the Properties tab.
2. In a Source Qualifier transformation, click the button in the User Defined Join field.
In an Application Source Qualifier transformation, click the button in the Join Override
field.
3. Enter the syntax for the join.
Do not enter WHERE at the beginning of the join. The PowerCenter Server adds this
when querying rows.
Enclose Informatica join syntax in braces ( { } ).
When using an alias for a table as well as the Informatica join syntax, use the alias within
the Informatica join syntax.
Use table names to prefix columns names, for example, “table.column”.
Use join conditions supported by the source database.
When entering multiple joins, group joins together by type, and then list them in the
following order: normal, left outer, right outer. Include only one right outer join per
nested query.
Select port names from the Ports tab to ensure accuracy.
4. Click OK.
To create an outer join as an extract override:
1. After connecting the input and output ports for the Application Source Qualifier
transformation, double-click the title bar of the transformation and select the Properties
tab.
2. In an Application Source Qualifier transformation, click the button in the Extract
Override field.
3. Click Generate SQL.
4. Enter the syntax for the join in the WHERE clause immediately after the WHERE.
Enclose Informatica join syntax in braces ( { } ).
When using an alias for a table as well as the Informatica join syntax, use the alias within
the Informatica join syntax.
Use table names to prefix columns names, for example, “table.column”.
Use join conditions supported by the source database.
Outer Join Support 313
When entering multiple joins, group joins together by type, and then list them in the
following order: normal, left outer, right outer. Include only one right outer join per
nested query.
Select port names from the Ports tab to ensure accuracy.
5. Click OK.
Common Database Syntax Restrictions
Different databases have different restrictions on outer join syntax. Consider the following
restrictions when you create outer joins:
♦ Do not combine join conditions with the OR operator in the ON clause of outer join
syntax.
♦ Do not use the IN operator to compare columns in the ON clause of outer join syntax.
♦ Do not compare a column to a subquery in the ON clause of outer join syntax.
♦ When combining two or more outer joins, do not use the same table as the inner table of
more than one outer join. For example, do not use either of the following outer joins:
{ TABLE1 LEFT OUTER JOIN TABLE2 ON TABLE1.COLUMNA = TABLE2.COLUMNA TABLE3
LEFT OUTER JOIN TABLE2 ON TABLE3.COLUMNB = TABLE2.COLUMNB }
{ TABLE1 LEFT OUTER JOIN TABLE2 ON TABLE1.COLUMNA = TABLE2.COLUMNA TABLE2
RIGHT OUTER JOIN TABLE3 ON TABLE2.COLUMNB = TABLE3.COLUMNB}
♦ Do not use both tables of an outer join in a regular join condition. For example, do not
use the following join condition:
{ TABLE1 LEFT OUTER JOIN TABLE2 ON TABLE1.COLUMNA = TABLE2.COLUMNA WHERE
TABLE1.COLUMNB = TABLE2.COLUMNC}
However, you can use both tables in a filter condition, like the following:
{ TABLE1 LEFT OUTER JOIN TABLE2 ON TABLE1.COLUMNA = TABLE2.COLUMNA WHERE
TABLE1.COLUMNB = 32 AND TABLE2.COLUMNC > 0}
Note: Entering a condition in the ON clause might return different results from entering
the same condition in the WHERE clause.
♦ When using an alias for a table, use the alias to prefix columns in the table. For example, if
you call the REG_CUSTOMER table C, when referencing the column FIRST_NAME,
use “C.FIRST_NAME”.
See your database documentation for details.
314 Chapter 15: Source Qualifier Transformation
Entering a Source Filter
You can enter a source filter to reduce the number of rows the PowerCenter Server queries. If
you include the string ‘WHERE’ or large objects in the source filter, the PowerCenter Server
fails the session.
The Source Qualifier transformation includes source filters in the default SQL query. If,
however, you modify the default query after adding a source filter, the PowerCenter Server
uses only the query defined in the SQL query portion of the Source Qualifier transformation.
You can include mapping parameters and variables in a source filter. When including a string
mapping parameter or variable, use a string identifier appropriate to the source system. For
most databases, you should enclose the name of a string parameter or variable in single
quotes. See your database documentation for details.
When you include a datetime parameter or variable, you might need to change the date
format to match the format used by the source. The PowerCenter Server converts a datetime
parameter and variable to a string based on the source system. For details on date conversion,
see Table 15-1 on page 295.
Note: When you enter a source filter in the session properties, you override the customized
SQL query in the Source Qualifier transformation.
To enter a source filter:
1. In the Mapping Designer, open a Source Qualifier transformation.
The Edit Transformations dialog box appears.
2. Select the Properties tab.
3. Click the Open button in the Source Filter field.
Enter the source filter.
Entering a Source Filter 315
4. In the SQL Editor dialog box, enter the filter.
Include the table name and port name. Do not include the keyword WHERE in the
filter.
Enclose string mapping parameters and variables in string identifiers. Alter the date
format for datetime mapping parameters and variables when necessary.
5. Click OK.
316 Chapter 15: Source Qualifier Transformation
Using Sorted Ports
When you use sorted ports, the PowerCenter Server adds the ports to the ORDER BY clause
in the default query. The PowerCenter Server adds the configured number of ports, starting at
the top of the Source Qualifier transformation. You might use sorted ports to improve
performance when you include any of the following transformations in a mapping:
♦ Aggregator. When you configure an Aggregator transformation for sorted input, you can
send sorted data by using sorted ports. The group by ports in the Aggregator
transformation must match the order of the sorted ports in the Source Qualifier
transformation. For more information about using a sorted Aggregator transformation, see
“Using Sorted Input” on page 9.
♦ Joiner. When you configure a Joiner transformation for sorted input, you can send sorted
data by using sorted ports. Configure the order of the sorted ports the same in each Source
Qualifier transformation. For more information about using a sorted Joiner
transformation, see “Using Sorted Input” on page 163.
Note: You can also use the Sorter transformation to sort relational and flat file data before
Aggregator and Joiner transformations. For more information about sorting data using the
Sorter transformation, see “Sorter Transformation” on page 283.
Use sorted ports for relational sources only. When using sorted ports, the sort order of the
source database must match the sort order configured for the session. The PowerCenter Server
creates the SQL query used to extract source data, including the ORDER BY clause for sorted
ports. The database server performs the query and passes the resulting data to the
PowerCenter Server. To ensure data is sorted as the PowerCenter Server requires, the database
sort order must be the same as the user-defined session sort order.
When you configure the PowerCenter Server for data code page validation and run a
workflow in Unicode data movement mode, the PowerCenter Server uses the selected sort
order to sort character data.
When you configure the PowerCenter Server for relaxed data code page validation, the
PowerCenter Server uses the selected sort order to sort all character data that falls in the
language range of the selected sort order. The Informatica sorts all character data outside the
language range of the selected sort order according to standard Unicode sort ordering.
When the PowerCenter Server runs in ASCII mode, it ignores this setting and sorts all
character data using a binary sort order. The default sort order depends on the code page of
the PowerCenter Server.
The Source Qualifier transformation includes the number of sorted ports in the default SQL
query. However, if you modify the default query after choosing the Number of Sorted Ports,
the PowerCenter Server uses only the query defined in the SQL Query property.
To use sorted ports:
1. In the Mapping Designer, open a Source Qualifier transformation, and click the
Properties tab.
Using Sorted Ports 317
2. Click in Number of Sorted Ports and enter the number of ports you want to sort.
The PowerCenter Server adds the configured number of columns to an ORDER BY
clause, starting from the top of the Source Qualifier transformation.
The source database sort order must correspond to the session sort order.
Tip: Sybase supports a maximum of 16 columns in an ORDER BY. If your source is
Sybase, do not sort more than 16 columns.
3. Click OK.
318 Chapter 15: Source Qualifier Transformation
Select Distinct
If you want the PowerCenter Server to select unique values from a source, you can use the
Select Distinct option. You might use this feature to extract unique customer IDs from a table
listing total sales. Using Select Distinct filters out unnecessary data earlier in the data flow,
which might improve performance.
By default, the Designer generates a SELECT statement. If you choose Select Distinct, the
Source Qualifier transformation includes the setting in the default SQL query.
For example, in the Source Qualifier transformation in Figure 15-2 on page 300, you enable
the Select Distinct option. The Designer adds SELECT DISTINCT to the default query as
follows:
SELECT DISTINCT CUSTOMERS.CUSTOMER_ID, CUSTOMERS.COMPANY,
CUSTOMERS.FIRST_NAME, CUSTOMERS.LAST_NAME, CUSTOMERS.ADDRESS1,
CUSTOMERS.ADDRESS2, CUSTOMERS.CITY, CUSTOMERS.STATE,
CUSTOMERS.POSTAL_CODE, CUSTOMERS.EMAIL, ORDERS.ORDER_ID,
ORDERS.DATE_ENTERED, ORDERS.DATE_PROMISED, ORDERS.DATE_SHIPPED,
ORDERS.EMPLOYEE_ID, ORDERS.CUSTOMER_ID, ORDERS.SALES_TAX_RATE,
ORDERS.STORE_ID
FROM
CUSTOMERS, ORDERS
WHERE
CUSTOMERS.CUSTOMER_ID=ORDERS.CUSTOMER_ID
However, if you modify the default query after choosing Select Distinct, the PowerCenter
Server uses only the query defined in the SQL Query property. In other words, the SQL
Query overrides the Select Distinct setting.
To use Select Distinct:
1. Open the Source Qualifier transformation in the mapping, and click on the Properties
tab.
2. Check Select Distinct, and Click OK.
Overriding Select Distinct in the Session
You can override the transformation level option to Select Distinct when you configure the
session in the Workflow Manager.
To override the Select Distinct option:
1. In the Workflow Manager, open the Session task, and click the Mapping tab.
2. Click the Transformations view, and click the Source Qualifier transformation under the
Sources node.
3. In the Properties settings, enable Select Distinct, and click OK.
Select Distinct 319
Adding Pre- and Post-Session SQL Commands
You can add pre- and post-session SQL commands on the Properties tab in the Source
Qualifier transformation. You might want to use pre-session SQL to write a timestamp row to
the source table when a session begins.
The PowerCenter Server runs pre-session SQL commands against the source database before
it reads the source. It runs post-session SQL commands against the source database after it
writes to the target.
You can override the SQL commands in the Transformations view on the Mapping tab in the
session properties. You can also configure the PowerCenter Server to stop or continue when it
encounters errors running pre- or post-session SQL commands. For more information about
stopping on errors, see “Working with Sessions” in the Workflow Administration Guide.
Use the following guidelines when you enter pre- and post-session SQL commands in the
Source Qualifier transformation:
♦ You can use any command that is valid for the database type. However, the PowerCenter
Server does not allow nested comments, even though the database might.
♦ You can use mapping parameters and variables in the source pre- and post-session SQL
commands.
♦ Use a semi-colon (;) to separate multiple statements.
♦ The PowerCenter Server ignores semi-colons within single quotes, double quotes, or
within /* ...*/.
♦ If you need to use a semi-colon outside of quotes or comments, you can escape it with a
back slash (\). When you escape the semi-colon, the PowerCenter Server ignores the
backslash, and it does not use the semi-colon as a statement separator.
♦ The Designer does not validate the SQL.
Note: You can also enter pre- and post-session SQL commands on the Properties tab of the
target instance in a mapping.
320 Chapter 15: Source Qualifier Transformation
Creating a Source Qualifier Transformation
You can configure the Designer to create a Source Qualifier transformation by default when
you drag a source into a mapping, or you can create a Source Qualifier transformation
manually.
Creating a Source Qualifier Transformation By Default
You can configure the Designer to automatically create a Source Qualifier transformation
when you drag a source into a mapping.
To create a Source Qualifier transformation automatically:
1. In the Designer, choose Tools-Options.
2. Select the Format tab.
3. In the Tools options, select Mapping Designer.
4. Select Create Source Qualifier When Opening Sources.
For more information about configuring Designer options, see “Using the Designer” in the
Designer Guide.
Creating a Source Qualifier Transformation Manually
You can manually create a Source Qualifier transformation in the Mapping Designer.
To create a Source Qualifier transformation manually:
1. In the Mapping Designer, choose Transformation-Create.
2. Enter a name for the transformation, and click Create.
3. Select a source, and click OK.
4. Click Done.
Configuring Source Qualifier Transformation Options
After you create the Source Qualifier transformation, you can configure several options.
To configure a Source Qualifier transformation:
1. In the Designer, open a mapping.
2. Double-click the title bar of the Source Qualifier transformation.
Creating a Source Qualifier Transformation 321
3. In the Edit Transformations dialog box, click Rename, enter a descriptive name for the
transformation, and click OK.
The naming convention for Source Qualifier transformations is
SQ_TransformationName, such as SQ_AllSources.
4. Click the Properties tab.
5. Enter any additional settings as needed:
Option Description
SQL Query Defines a custom query that replaces the default query the PowerCenter Server
uses to read data from sources represented in this Source Qualifier
transformation. For more information, see “Adding an SQL Query” on page 303. A
custom query overrides entries for a custom join or a source filter.
User-Defined Join Specifies the condition used to join data from multiple sources represented in the
same Source Qualifier transformation. For more information, see “Entering a
User-Defined Join” on page 305.
Source Filter Specifies the filter condition the PowerCenter Server applies when querying rows.
For more information, see “Entering a Source Filter” on page 315.
Number of Sorted Ports Indicates the number of columns used when sorting rows queried from relational
sources. If you select this option, the PowerCenter Server adds an ORDER BY to
the default query when it reads source rows. The ORDER BY includes the number
of ports specified, starting from the top of the transformation.
When selected, the database sort order must match the session sort order.
Tracing Level Sets the amount of detail included in the session log when you run a session
containing this transformation. For more information, see “Transformations” in the
Designer Guide.
Select Distinct Specifies if you want to select only unique rows. The PowerCenter Server
includes a SELECT DISTINCT statement if you choose this option.
Pre-SQL Pre-session SQL commands to run against the source database before the
PowerCenter Server reads the source. For more information, see “Adding Pre-
and Post-Session SQL Commands” on page 320.
Post-SQL Post-session SQL commands to run against the source database after the
PowerCenter Server writes to the target. For more information, see “Adding Pre-
and Post-Session SQL Commands” on page 320.
6. Click the Sources tab and indicate any associated source definitions you want to define
for this transformation.
Identify associated sources only when you need to join data from multiple databases or
flat file systems.
7. Click OK to return to the Designer.
322 Chapter 15: Source Qualifier Transformation
Troubleshooting
I cannot perform a drag and drop operation, such as connecting ports.
Review the error message on the status bar for details.
I cannot connect a source definition to a target definition.
You cannot directly connect sources to targets. Instead, you need to connect them through a
Source Qualifier transformation for relational and flat file sources, or through a Normalizer
transformation for COBOL sources.
I cannot connect multiple sources to one target.
The Designer does not allow you to connect multiple Source Qualifier transformations to a
single target. There are two workarounds:
♦ Reuse targets. Since target definitions are reusable, you can add the same target to the
mapping multiple times. Then, connect each Source Qualifier transformation to each
target.
♦ Join the sources in a Source Qualifier transformation. Then, remove the WHERE clause
from the SQL query.
I entered a custom query, but it is not working when I run the workflow containing the
session.
Be sure to test this setting for the Source Qualifier transformation before you run the
workflow. Return to the Source Qualifier transformation and reopen the dialog box in which
you entered the custom query. You can connect to a database and click the Validate button to
test your SQL. The Designer displays any errors. Review the session log file if you need
further information.
The most common reason a session fails is because the database login in both the session and
Source Qualifier transformation is not the table owner. You need to specify the table owner in
the session and when you generate the SQL Query in the Source Qualifier transformation.
You can test the SQL Query by cutting and pasting it into the database client tool (such as
SQL*Net) to see if it returns an error.
I used a mapping variable in a source filter and now the session fails.
Try testing the query by generating and validating the SQL in the Source Qualifier
transformation. If the variable or parameter is a string, you probably need to enclose it in
single quotes. If it is a datetime variable or parameter, you might need to change its format for
the source system.
Troubleshooting 323
324 Chapter 15: Source Qualifier Transformation
Chapter 16
Stored Procedure
Transformation
This chapter covers the following topics:
♦ Overview, 326
♦ Stored Procedure Transformation Steps, 331
♦ Writing a Stored Procedure, 332
♦ Creating a Stored Procedure Transformation, 335
♦ Configuring a Connected Transformation, 341
♦ Configuring an Unconnected Transformation, 343
♦ Error Handling, 349
♦ Supported Databases, 351
♦ Expression Rules, 353
♦ Tips, 354
♦ Troubleshooting, 355
325
Overview
Transformation type:
Passive
Connected/Unconnected
A Stored Procedure transformation is an important tool for populating and maintaining
databases. Database administrators create stored procedures to automate tasks that are too
complicated for standard SQL statements.
A stored procedure is a precompiled collection of Transact-SQL, PL-SQL or other database
procedural statements and optional flow control statements, similar to an executable script.
Stored procedures are stored and run within the database. You can run a stored procedure
with the EXECUTE SQL statement in a database client tool, just as you can run SQL
statements. Unlike standard SQL, however, stored procedures allow user-defined variables,
conditional statements, and other powerful programming features.
Not all databases support stored procedures, and stored procedure syntax varies depending on
the database. You might use stored procedures to do the following tasks:
♦ Check the status of a target database before loading data into it.
♦ Determine if enough space exists in a database.
♦ Perform a specialized calculation.
♦ Drop and recreate indexes.
Database developers and programmers use stored procedures for various tasks within
databases, since stored procedures allow greater flexibility than SQL statements. Stored
procedures also provide error handling and logging necessary for critical tasks. Developers
create stored procedures in the database using the client tools provided with the database.
The stored procedure must exist in the database before creating a Stored Procedure
transformation, and the stored procedure can exist in a source, target, or any database with a
valid connection to the PowerCenter Server.
You might use a stored procedure to perform a query or calculation that you would otherwise
make part of a mapping. For example, if you already have a well-tested stored procedure for
calculating sales tax, you can perform that calculation through the stored procedure instead of
recreating the same calculation in an Expression transformation.
326 Chapter 16: Stored Procedure Transformation
Input and Output Data
One of the most useful features of stored procedures is the ability to send data to the stored
procedure, and receive data from the stored procedure. There are three types of data that pass
between the PowerCenter Server and the stored procedure:
♦ Input/output parameters
♦ Return values
♦ Status codes
Some limitations exist on passing data, depending on the database implementation, which are
discussed throughout this chapter. Additionally, not all stored procedures send and receive
data. For example, if you write a stored procedure to rebuild a database index at the end of a
session, you cannot receive data, since the session has already finished.
Input/Output Parameters
For many stored procedures, you provide a value and receive a value in return. These values
are known as input and output parameters. For example, a sales tax calculation stored
procedure can take a single input parameter, such as the price of an item. After performing
the calculation, the stored procedure returns two output parameters, the amount of tax, and
the total cost of the item including the tax.
The Stored Procedure transformation sends and receives input and output parameters using
ports, variables, or by entering a value in an expression, such as 10 or SALES.
Return Values
Most databases provide a return value after running a stored procedure. Depending on the
database implementation, this value can either be user-definable, which means that it can act
similar to a single output parameter, or it may only return an integer value.
The Stored Procedure transformation captures return values in a similar manner as input/
output parameters, depending on the method that the input/output parameters are captured.
In some instances, only a parameter or a return value can be captured.
Note: An Oracle stored function is similar to an Oracle stored procedure, except that the
stored function supports output parameters or return values. In this chapter, any statements
regarding stored procedures also apply to stored functions, unless otherwise noted.
Status Codes
Status codes provide error handling for the PowerCenter Server during a workflow. The stored
procedure issues a status code that notifies whether or not the stored procedure completed
successfully. You cannot see this value. The PowerCenter Server uses it to determine whether
to continue running the session or stop. You configure options in the Workflow Manager to
continue or stop the session in the event of a stored procedure error.
Overview 327
Connected and Unconnected
Stored procedures run in either connected or unconnected mode. The mode you use depends
on what the stored procedure does and how you plan to use it in your session. You can
configure connected and unconnected Stored Procedure transformations in a mapping.
♦ Connected. The flow of data through a mapping in connected mode also passes through
the Stored Procedure transformation. All data entering the transformation through the
input ports affects the stored procedure. You should use a connected Stored Procedure
transformation when you need data from an input port sent as an input parameter to the
stored procedure, or the results of a stored procedure sent as an output parameter to
another transformation.
♦ Unconnected. The unconnected Stored Procedure transformation is not connected
directly to the flow of the mapping. It either runs before or after the session, or is called by
an expression in another transformation in the mapping.
Table 16-1 compares connected and unconnected transformations:
Table 16-1. Comparison of Connected and Unconnected Stored Procedure Transformations
If you want to Use this mode
Run a stored procedure before or after your session. Unconnected
Run a stored procedure once during your mapping, such as pre- or post-session. Unconnected
Run a stored procedure every time a row passes through the Stored Procedure Connected or
transformation. Unconnected
Run a stored procedure based on data that passes through the mapping, such as when a Unconnected
specific port does not contain a null value.
Pass parameters to the stored procedure and receive a single output parameter. Connected or
Unconnected
Pass parameters to the stored procedure and receive multiple output parameters. Connected or
Note: To get multiple output parameters from an unconnected Stored Procedure Unconnected
transformation, you must create variables for each output parameter. For details, see “Calling
a Stored Procedure From an Expression” on page 343.
Run nested stored procedures. Unconnected
Call multiple times within a mapping. Unconnected
For more information, see “Configuring a Connected Transformation” on page 341 and
“Configuring an Unconnected Transformation” on page 343.
Specifying when the Stored Procedure Runs
In addition to specifying the mode of the Stored Procedure transformation, you also specify
when it runs. In the case of the unconnected stored procedure above, the Expression
transformation references the stored procedure, which means the stored procedure runs every
time a row passes through the Expression transformation. However, if no transformation
328 Chapter 16: Stored Procedure Transformation
references the Stored Procedure transformation, you have the option to run the stored
procedure once before or after the session.
The following list describes the options for running a Stored Procedure transformation:
♦ Normal. The stored procedure runs where the transformation exists in the mapping on a
row-by-row basis. This is useful for calling the stored procedure for each row of data that
passes through the mapping, such as running a calculation against an input port.
Connected stored procedures run only in normal mode.
♦ Pre-load of the Source. Before the session retrieves data from the source, the stored
procedure runs. This is useful for verifying the existence of tables or performing joins of
data in a temporary table.
♦ Post-load of the Source. After the session retrieves data from the source, the stored
procedure runs. This is useful for removing temporary tables.
♦ Pre-load of the Target. Before the session sends data to the target, the stored procedure
runs. This is useful for verifying target tables or disk space on the target system.
♦ Post-load of the Target. After the session sends data to the target, the stored procedure
runs. This is useful for re-creating indexes on the database.
You can run several Stored Procedure transformations in different modes in the same
mapping. For example, a pre-load source stored procedure can check table integrity, a normal
stored procedure can populate the table, and a post-load stored procedure can rebuild indexes
in the database. However, you cannot run the same instance of a Stored Procedure
transformation in both connected and unconnected mode in a mapping. You must create
different instances of the transformation.
If the mapping calls more than one source or target pre- or post-load stored procedure in a
mapping, the PowerCenter Server executes the stored procedures in the execution order that
you specify in the mapping.
The PowerCenter Server executes each stored procedure using the database connection you
specify in the transformation properties. The PowerCenter Server opens the database
connection when it encounters the first stored procedure. The database connection remains
open until the PowerCenter Server finishes processing all stored procedures for that
connection. The PowerCenter Server closes the database connections and opens a new one
when it encounters a stored procedure using a different database connection.
To run multiple stored procedures that use the same database connection, set these stored
procedures to run consecutively. If you do not set them to run consecutively, you might have
unexpected results in your target. For example, you have two stored procedures: Stored
Procedure A and Stored Procedure B. Stored Procedure A begins a transaction, and Stored
Procedure B commits the transaction. If you run Stored Procedure C before Stored Procedure
B, using another database connection, Stored Procedure B cannot commit the transaction
because the PowerCenter Server closes the database connection when it runs Stored Procedure
C.
Overview 329
Use the following guidelines to run multiple stored procedures within a database connection:
♦ The stored procedures use the same database connect string defined in the stored
procedure properties.
♦ You set the stored procedures to run in consecutive order.
♦ The stored procedures have the same stored procedure type:
− Source pre-load
− Source post-load
− Target pre-load
− Target post-load
330 Chapter 16: Stored Procedure Transformation
Stored Procedure Transformation Steps
You must perform several steps to use a Stored Procedure transformation in a mapping. Since
the stored procedure exists in the database, you must configure not only the mapping and
session, but the stored procedure in the database as well. The following sections in this
chapter detail each of the following steps.
To use a Stored Procedure transformation:
1. Create the stored procedure in the database.
Before using the Designer to create the transformation, you must create the stored
procedure in the database. You should also test the stored procedure through the
provided database client tools.
2. Import or create the Stored Procedure transformation.
Use the Designer to import or create the Stored Procedure transformation, providing
ports for any necessary input/output and return values.
3. Determine whether to use the transformation as connected or unconnected.
You must determine how the stored procedure relates to the mapping before configuring
the transformation.
4. If connected, map the appropriate input and output ports.
You use connected Stored Procedure transformations just as you would most other
transformations. Click and drag the appropriate input flow ports to the transformation,
and create mappings from output ports to other transformations.
5. If unconnected, either configure the stored procedure to run pre- or post-session, or
configure it to run from an expression in another transformation.
Since stored procedures can run before or after the session, you may need to specify when
the unconnected transformation should run. On the other hand, if the stored procedure
is called from another transformation, you write the expression in another transformation
that calls the stored procedure. The expression can contain variables, and may or may not
include a return value.
6. Configure the session.
The session properties in the Workflow Manager includes options for error handling
when running stored procedures and several SQL override options.
Stored Procedure Transformation Steps 331
Writing a Stored Procedure
You write SQL statements to create a stored procedure in your database, and you can add
other Transact-SQL statements and database-specific functions. These can include user-
defined datatypes and execution order statements. For more information, see your database
documentation.
Sample Stored Procedure
In the following example, the source database has a stored procedure that takes an input
parameter of an employee ID number, and returns an output parameter of the employee
name. In addition, a return value of 0 is returned as a notification that the stored procedure
completed successfully. The database table that contains employee IDs and names appears as
follows:
Employee ID Employee Name
101 Bill Takash
102 Louis Li
103 Sarah Ferguson
The stored procedure receives the employee ID 101 as an input parameter, and returns the
name Bill Takash. Depending on how the mapping calls this stored procedure, any or all of
the IDs may be passed to the stored procedure.
Since the syntax varies between databases, the SQL statements to create this stored procedure
may vary. The client tools used to pass the SQL statements to the database also vary. Most
databases provide a set of client tools, including a standard SQL editor. Some databases, such
as Microsoft SQL Server, provide tools that create some of the initial SQL statements
automatically.
In all cases, consult your database documentation for more detailed descriptions and
examples.
Note: The PowerCenter Server fails sessions that contain stored procedure arguments with
large objects.
Informix
In Informix, the syntax for declaring an output parameter differs from other databases. With
most databases, you declare variables using IN or OUT to specify if the variable acts as an
input or output parameter. Informix uses the keyword RETURNING, making it difficult to
distinguish input/output parameters from return values. For example, you use the RETURN
command to return one or more output parameters:
CREATE PROCEDURE GET_NAME_USING_ID (nID integer)
RETURNING varchar(20);
332 Chapter 16: Stored Procedure Transformation
define nID integer;
define outVAR as varchar(20);
SELECT FIRST_NAME INTO outVAR FROM CONTACT WHERE ID = nID
return outVAR;
END PROCEDURE;
Notice that in this case, the RETURN statement passes the value of outVAR. Unlike other
databases, however, outVAR is not a return value, but an output parameter. Multiple output
parameters would be returned in the following manner:
return outVAR1, outVAR2, outVAR3
Informix does pass a return value. The return value is not user-defined, but generated as an
error-checking value. In the transformation, the R value must be checked.
Oracle
In Oracle, any stored procedure that returns a value is called a stored function. Rather than
using the CREATE PROCEDURE statement to make a new stored procedure based on the
example, you use the CREATE FUNCTION statement. In this sample, the variables are
declared as IN and OUT, but Oracle also supports an INOUT parameter type, which allows
you to pass in a parameter, modify it, and return the modified value:
CREATE OR REPLACE FUNCTION GET_NAME_USING_ID (
nID IN NUMBER,
outVAR OUT VARCHAR2)
RETURN VARCHAR2 IS
RETURN_VAR varchar2(100);
BEGIN
SELECT FIRST_NAME INTO outVAR FROM CONTACT WHERE ID = nID;
RETURN_VAR := 'Success';
RETURN (RETURN_VAR);
END;
/
Notice that the return value is a string value (Success) with the datatype VARCHAR2. Oracle
is the only database to allow return values with string datatypes.
Sybase SQL Server/Microsoft SQL Server
Sybase and Microsoft implement stored procedures identically, as the following syntax
illustrates:
CREATE PROCEDURE GET_NAME_USING_ID @nID int = 1, @outVar varchar(20)
OUTPUT
AS
Writing a Stored Procedure 333
SELECT @outVar = FIRST_NAME FROM CONTACT WHERE ID = @nID
return 0
Notice that the return value does not need to be a variable. In this case, if the SELECT
statement is successful, a 0 is returned as the return value.
IBM DB2
The following text is an example of an SQL stored procedure on IBM DB2:
CREATE PROCEDURE get_name_using_id ( IN id_in int,
OUT emp_out char(18),
OUT sqlcode_out int)
LANGUAGE SQL
P1: BEGIN
-- Declare variables
DECLARE SQLCODE INT DEFAULT 0;
DECLARE emp_TMP char(18) DEFAULT ' ';
-- Declare handler
DECLARE EXIT HANDLER FOR SQLEXCEPTION
SET SQLCODE_OUT = SQLCODE;
select employee into emp_TMP
from doc_employee
where id = id_in;
SET emp_out = EMP_TMP;
SET sqlcode_out = SQLCODE;
END P1
Teradata
The following text is an example of an SQL stored procedure on Teradata. It takes an
employee ID number as an input parameter and returns the employee name as an output
parameter:
CREATE PROCEDURE GET_NAME_USING_ID (IN nID integer, OUT outVAR
varchar(40))
BEGIN
SELECT FIRST_NAME INTO :outVAR FROM CONTACT where ID = :nID;
END;
334 Chapter 16: Stored Procedure Transformation
Creating a Stored Procedure Transformation
After you configure and test a stored procedure in the database, you must create the Stored
Procedure transformation in the Mapping Designer. There are two ways to configure the
Stored Procedure transformation:
♦ Use the Import Stored Procedure dialog box to automatically configure the ports used by
the stored procedure.
♦ Configure the transformation manually, creating the appropriate ports for any input or
output parameters.
Stored Procedure transformations are created as Normal type by default, which means that
they run during the mapping, not before or after the session.
New Stored Procedure transformations are not created as reusable transformations. To create a
reusable transformation, click Make Reusable in the Transformation properties after creating
the transformation.
Note: Configure the properties of reusable transformations in the Transformation Developer,
not the Mapping Designer, to make changes globally for the transformation.
Importing Stored Procedures
When you import a stored procedure, the Designer creates ports based on the stored
procedure input and output parameters. You should import the stored procedure whenever
possible.
There are three ways to import a stored procedure in the Mapping Designer:
♦ Select the stored procedure icon and add a Stored Procedure transformation.
♦ Select Transformation-Import Stored Procedure.
♦ Select Transformation-Create, and then select Stored Procedure.
Note: When you import a stored procedure containing a period (.) in the stored procedure
name, the Designer substitutes an underscore (_) for the period in the Stored Procedure
transformation name.
To import a stored procedure:
1. In the Mapping Designer, choose Transformation-Import Stored Procedure.
Creating a Stored Procedure Transformation 335
2. Select the database that contains the stored procedure from the list of ODBC sources.
Enter the user name, owner name, and password to connect to the database and click
Connect.
Notice the folder in the dialog box displays FUNCTIONS. The stored procedures listed
in this folder contain input parameters, output parameters, or a return value. If stored
procedures exist in the database that do not contain parameters or return values, they
appear in a folder called PROCEDURES. This applies primarily to Oracle stored
procedures. For a normal connected Stored Procedure to appear in the functions list, it
requires at least one input and one output port.
Tip: You can select Skip to add a Stored Procedure transformation without importing the
stored procedure. In this case, you need to manually add the ports and connect
information within the transformation. For details, see “Manually Creating Stored
Procedure Transformations” on page 337.
3. Select the procedure to import and click OK.
The Stored Procedure transformation appears in the mapping. The Stored Procedure
transformation name is the same as the stored procedure you selected. If the stored
procedure contains input parameters, output parameters, or a return value, you see the
appropriate ports that match each parameter or return value in the Stored Procedure
transformation.
336 Chapter 16: Stored Procedure Transformation
In this Stored Procedure transformation, you can see that the stored procedure contains
the following value and parameters:
♦ An integer return value, called RETURN_VALUE, with an output port.
♦ A string input parameter, called nNAME, with an input port.
♦ An integer output parameter, called outVar, with an input and output port.
Note: If you change the transformation name, you need to configure the name of the
stored procedure in the transformation properties. If you have multiple instances of the
same stored procedure in a mapping, you must also configure the name of the stored
procedure.
4. Open the transformation, and click the Properties tab.
Select the database where the stored procedure exists from the Connection Information
row. If you changed the name of the Stored Procedure transformation to something other
than the name of the stored procedure, enter the Stored Procedure Name.
5. Click OK.
6. Choose Repository-Save to save changes to the mapping.
Manually Creating Stored Procedure Transformations
To create a Stored Procedure transformation manually, you need to know the input
parameters, output parameters, and return values of the stored procedure, if there are any. You
must also know the datatypes of those parameters, and the name of the stored procedure
itself. All these are configured automatically through Import Stored Procedure.
To create a Stored Procedure transformation:
1. In the Mapping Designer, choose Transformation-Create, and then select Stored
Procedure.
The naming convention for a Stored Procedure transformation is the name of the stored
procedure, which happens automatically. If you change the transformation name, then
you need to configure the name of the stored procedure in the Transformation Properties.
If you have multiple instances of the same stored procedure in a mapping, you must
perform this step.
2. Click Skip.
The Stored Procedure transformation appears in the Mapping Designer.
3. Open the transformation, and click the Ports tab.
You must create ports based on the input parameters, output parameters, and return
values in the stored procedure. Create a port in the Stored Procedure transformation for
each of the following stored procedure parameters:
♦ An integer input parameter
♦ A string output parameter
♦ A return value
Creating a Stored Procedure Transformation 337
For the integer input parameter, you would create an integer input port. The parameter
and the port must be the same datatype and precision. Repeat this for the output
parameter and the return value.
The R column should be selected as well as the output port for the return value. For
stored procedures with multiple parameters, you must list the ports in the same order
that they appear in the stored procedure.
4. Click the Properties tab.
Enter the name of the stored procedure in the Stored Procedure Name row, and select the
database where the stored procedure exists from the Connection Information row.
5. Click OK.
6. Choose Repository-Save to save changes to the mapping.
Although the repository validates and saves the mapping, the Designer does not validate the
manually entered Stored Procedure transformation. No checks are completed to verify that
the proper parameters or return value exist in the stored procedure. If the Stored Procedure
transformation is not configured properly, the session fails.
Setting Options for the Stored Procedure
Table 16-2 describes the properties for a Stored Procedure transformation:
Table 16-2. Setting Options for the Stored Procedure Transformation
Setting Description
Stored Procedure Name The name of the stored procedure in the database. The PowerCenter Server uses
this text to call the stored procedure if the name of the transformation is different than
the actual stored procedure name in the database. Leave this field blank if the
transformation name matches the stored procedure name. When using the Import
Stored Procedure feature, this name matches the stored procedure automatically.
Connection Information Specifies the database containing the stored procedure. You can select the exact
database or you can use the $Source or $Target variable. By default, the Designer
specifies $Target for Normal stored procedure types.
For source pre- and post-load, the Designer specifies $Source. For target pre- and
post-load, the Designer specifies $Target. You can override these values in the
Workflow Manager session properties.
If you use one of these variables, the stored procedure must reside in the source or
target database you specify when you run the session.
If you use $Source or $Target, you can specify the database connection for each
variable in the session properties.
The PowerCenter Server fails the session if it cannot determine the type of database
connection.
For more information about using $Source and $Target, see “Using $Source and
$Target Variables” on page 339.
Call Text The text used to call the stored procedure. Only used when the Stored Procedure
Type is not Normal. You must include any input parameters passed to the stored
procedure within the call text. For details, see “Calling a Pre- or Post-Session Stored
Procedure” on page 346.
338 Chapter 16: Stored Procedure Transformation
Table 16-2. Setting Options for the Stored Procedure Transformation
Setting Description
Stored Procedure Type Determines when the PowerCenter Server calls the stored procedure. The options
include Normal (during the mapping) or pre- or post-load on the source or target
database. The default setting is Normal.
Execution Order The order in which the PowerCenter Server calls the stored procedure used in the
transformation, relative to any other stored procedures in the same mapping. Only
used when the Stored Procedure Type is set to anything except Normal and more
than one stored procedure exists.
Using $Source and $Target Variables
You can use either the $Source or $Target variable when you specify the database location for
a Stored Procedure transformation. You can use these variables in the Connection
Information property for a Stored Procedure transformation.
You can also use these variables for Lookup transformations. For more information, see
“Lookup Properties” on page 186.
When you configure a session, you can specify a database connection value for $Source or
$Target. This ensures the PowerCenter Server uses the correct database connection for the
variable when it runs the session. You can configure the $Source Connection Value and
$Target Connection Value properties on the General Options settings of the Properties tab in
the session properties.
However, if you do not specify $Source Connection Value or $Target Connection Value in
the session properties, the PowerCenter Server determines the database connection to use
when it runs the session. It uses a source or target database connection for the source or target
in the pipeline that contains the Stored Procedure transformation. If it cannot determine
which database connection to use, it fails the session.
The following list describes how the PowerCenter Server determines the value of $Source or
$Target when you do not specify $Source Connection Value or $Target Connection Value in
the session properties:
♦ When you use $Source and the pipeline contains one relational source, the PowerCenter
Server uses the database connection you specify for the source.
♦ When you use $Source and the pipeline contains multiple relational sources joined by a
Joiner transformation, the PowerCenter Server uses different database connections,
depending on the location of the Stored Procedure transformation in the pipeline:
− When the Stored Procedure transformation is after the Joiner transformation, the
PowerCenter Server uses the database connection for the detail table.
− When the Stored Procedure transformation is before the Joiner transformation, the
PowerCenter Server uses the database connection for the source connected to the Stored
Procedure transformation.
♦ When you use $Target and the pipeline contains one relational target, the PowerCenter
Server uses the database connection you specify for the target.
Creating a Stored Procedure Transformation 339
♦ When you use $Target and the pipeline contains multiple relational targets, the session
fails.
♦ When you use $Source or $Target in an unconnected Stored Procedure transformation,
the session fails.
Changing the Stored Procedure
If the number of parameters or the return value in a stored procedure changes, you can either
re-import it or edit the Stored Procedure transformation manually. The Designer does not
automatically verify the Stored Procedure transformation each time you open the mapping.
After you import or create the transformation, the Designer does not validate the stored
procedure. The session fails if the stored procedure does not match the transformation.
340 Chapter 16: Stored Procedure Transformation
Configuring a Connected Transformation
Figure 16-1 illustrates a mapping that sends the ID from the Source Qualifier to an input
parameter in the Stored Procedure transformation and retrieves an output parameter from the
Stored Procedure transformation that is sent to the target. Every row of data in the Source
Qualifier transformation passes data through the Stored Procedure transformation:
Figure 16-1. Sample Mapping With a Stored Procedure Transformation
Although not required, almost all connected Stored Procedure transformations contain input
and output parameters. Required input parameters are specified as the input ports of the
Stored Procedure transformation. Output parameters appear as output ports in the
transformation. A return value is also an output port, and has the R value selected in the
transformation Ports configuration. For a normal connected Stored Procedure to appear in
the functions list, it requires at least one input and one output port.
Output parameters and return values from the stored procedure are used as any other output
port in a transformation. You can map the value of these ports directly to another
transformation or target.
To configure a connected Stored Procedure transformation:
1. Create the Stored Procedure transformation in the mapping.
For details, see “Creating a Stored Procedure Transformation” on page 335.
2. Drag ports from upstream transformations to connect to any available input ports.
3. Drag ports from the output ports of the Stored Procedure to other transformations or
targets.
4. Open the Stored Procedure transformations, and select the Properties tab.
Select the appropriate database in the Connection Information if you did not select it
when creating the transformation.
Configuring a Connected Transformation 341
Select the Tracing level for the transformation. If you are testing the mapping, select the
Verbose Initialization option to provide the most information in the event that the
transformation fails. Click OK.
5. Choose Repository-Save to save changes to the mapping.
342 Chapter 16: Stored Procedure Transformation
Configuring an Unconnected Transformation
An unconnected Stored Procedure transformation is not directly connected to the flow of data
through the mapping. Instead, the stored procedure runs either:
♦ From an expression. Called from an expression written in the Expression Editor within
another transformation in the mapping.
♦ Pre- or post-session. Runs before or after a session.
The sections below explain how you can run an unconnected Stored Procedure
transformation.
Calling a Stored Procedure From an Expression
In an unconnected mapping, the Stored Procedure transformation does not connect to the
pipeline.
Figure 16-2 illustrates a mapping with an Expression transformation that references the
Stored Procedure transformation:
Figure 16-2. Expression Transformation Referencing a Stored Procedure Transformation
However, just like a connected mapping, you can apply the stored procedure to the flow of
data through the mapping. In fact, you have greater flexibility since you use an expression to
call the stored procedure, which means you can select the data that you pass to the stored
procedure as an input parameter.
When using an unconnected Stored Procedure transformation in an expression, you need a
method of returning the value of output parameters to a port. Use one of the following
methods to capture the output values:
♦ Assign the output value to a local variable.
♦ Assign the output value to the system variable PROC_RESULT.
Configuring an Unconnected Transformation 343
By using PROC_RESULT, you assign the value of the return parameter directly to an output
port, which can apply directly to a target. You can also combine the two options by assigning
one output parameter as PROC_RESULT, and the other parameter as a variable.
Use PROC_RESULT only within an expression. If you do not use PROC_RESULT or a
variable, the port containing the expression captures a NULL. You cannot use
PROC_RESULT in a connected Lookup transformation or within the Call Text for a Stored
Procedure transformation.
If you require nested stored procedures, where the output parameter of one stored procedure
passes to another stored procedure, use PROC_RESULT to pass the value.
The PowerCenter Server calls the unconnected Stored Procedure transformation from the
Expression transformation. Notice that the Stored Procedure transformation has two input
ports and one output port. All three ports are string datatypes.
To call a stored procedure from within an expression:
1. Create the Stored Procedure transformation in the mapping.
For details, see “Creating a Stored Procedure Transformation” on page 335.
2. In any transformation that supports output and variable ports, create a new output port
in the transformation that calls the stored procedure. Name the output port.
Output Port
The output port that calls the stored procedure must support expressions. Depending on
how the expression is configured, the output port contains the value of the output
parameter or the return value.
3. Open the Expression Editor for the port.
The value for the new port is set up in the Expression Editor as a call to the stored
procedure using the :SP keyword in the Transformation Language. The easiest way to set
this up properly is to select the Stored Procedures node in the Expression Editor, and
344 Chapter 16: Stored Procedure Transformation
click the name of Stored Procedure transformation listed. For a normal connected Stored
Procedure to appear in the functions list, it requires at least one input and one output
port.
The stored procedure appears in the Expression Editor with a pair of empty parentheses.
The necessary input and/or output parameters are displayed in the lower left corner of
the Expression Editor.
4. Configure the expression to send input parameters and capture output parameters or
return value.
You must know whether the parameters shown in the Expression Editor are input or
output parameters. You insert variables or port names between the parentheses in the
exact order that they appear in the stored procedure itself. The datatypes of the ports and
variables must match those of the parameters passed to the stored procedure.
For example, when you click the stored procedure, something similar to the following
appears:
:SP.GET_NAME_FROM_ID()
This particular stored procedure requires an integer value as an input parameter and
returns a string value as an output parameter. How the output parameter or return value
is captured depends on the number of output parameters and whether the return value
needs to be captured.
If the stored procedure returns a single output parameter or a return value (but not both),
you should use the reserved variable PROC_RESULT as the output variable. In the
previous example, the expression would appear as:
:SP.GET_NAME_FROM_ID(inID, PROC_RESULT)
inID can be either an input port for the transformation or a variable in the
transformation. The value of PROC_RESULT is applied to the output port for the
expression.
Configuring an Unconnected Transformation 345
If the stored procedure returns multiple output parameters, you must create variables for
each output parameter. For example, if you create a port called varOUTPUT2 for the
stored procedure expression, and a variable called varOUTPUT1, the expression appears
as:
:SP.GET_NAME_FROM_ID(inID, varOUTPUT1, PROC_RESULT)
The value of the second output port is applied to the output port for the expression, and
the value of the first output port is applied to varOUTPUT1. The output parameters are
returned in the order they are declared in the stored procedure.
With all these expressions, the datatypes for the ports and variables must match the
datatypes for the input/output variables and return value.
5. Click Validate to verify the expression, and then click OK to close the Expression Editor.
Validating the expression ensures that the datatypes for parameters in the stored
procedure match those entered in the expression.
6. Click OK.
7. Choose Repository-Save to save changes to the mapping.
When you save the mapping, the Designer does not validate the stored procedure
expression. If the stored procedure expression is not configured properly, the session fails.
When testing a mapping using a stored procedure, set the Override Tracing session
option to a verbose mode and configure the On Stored Procedure session option to stop
running if the stored procedure fails. Configure these session options in the Error
Handling settings of the Config Object tab in the session properties. For details on
setting the tracing level, see “Log Files” in the Workflow Administration Guide. For details
on the On Stored Procedure Error session property, see “Session Properties Reference” in
the Workflow Administration Guide.
The stored procedure in the expression entered for a port does not have to affect all values
that pass through the port. Using the IIF statement, for example, you can pass only certain
values, such as ID numbers that begin with 5, to the stored procedure and skip all other
values. You can also set up nested stored procedures so the return value of one stored
procedure becomes an input parameter for a second stored procedure.
For details on configuring the stored procedure expression, see “Expression Rules” on
page 353.
Calling a Pre- or Post-Session Stored Procedure
You may want to run a stored procedure once per session. For example, if you need to verify
that tables exist in a target database before running a mapping, a pre-load target stored
procedure can check the tables, and then either continue running the workflow or stop it. You
can run a stored procedure on the source, target, or any other connected database.
To create a pre- or post-load stored procedure:
1. Create the Stored Procedure transformation in your mapping.
346 Chapter 16: Stored Procedure Transformation
For details, see “Creating a Stored Procedure Transformation” on page 335.
2. Double-click the Stored Procedure transformation, and select the Properties tab.
3. Enter the name of the stored procedure.
If you imported the stored procedure, this should be set correctly. If you manually set up
the stored procedure, enter the name of the stored procedure.
4. Select the database that contains the stored procedure in Connection Information.
5. Enter the call text of the stored procedure.
This is the name of the stored procedure, followed by any applicable input parameters in
parentheses. If there are no input parameters, you must include an empty pair of
parentheses, or the call to the stored procedure fails. You do not need to include the SQL
statement EXEC, nor do you need to use the :SP keyword. For example, to call your
stored procedure called check_disk_space, enter the following:
check_disk_space()
To pass a string input parameter, enter it without quotes. If the string has spaces in it,
enclose the parameter in double quotes. For example, if the stored procedure
check_disk_space required a machine name as an input parameter, enter the following:
check_disk_space(oracle_db)
You must enter values for the parameters, since pre- and post-session procedures cannot
pass variables.
When passing a datetime value through a pre- or post-session stored procedure, the value
must be in the Informatica default date format and enclosed in double quotes as follows:
SP(“12/31/2000 11:45:59”)
6. Select the stored procedure type.
Configuring an Unconnected Transformation 347
The options for stored procedure type include:
♦ Source Pre-load. Before the session retrieves data from the source, the stored
procedure runs. This is useful for verifying the existence of tables or performing joins
of data in a temporary table.
♦ Source Post-load. After the session retrieves data from the source, the stored procedure
runs. This is useful for removing temporary tables.
♦ Target Pre-load. Before the session sends data to the target, the stored procedure runs.
This is useful for verifying target tables or disk space on the target system.
♦ Target Post-load. After the session sends data to the target, the stored procedure runs.
This is useful for re-creating indexes on the database.
7. Select Execution Order, and click the Up or Down arrow to change the order, if
necessary.
If you have added several stored procedures that execute at the same point in a session
(such as two procedures that both run at Source Post-load), you can set a stored
procedure execution plan to determine the order in which the PowerCenter Server calls
these stored procedures. You need to repeat this step for each stored procedure you wish
to change.
8. Click OK.
9. Choose Repository-Save to save changes to the mapping.
Although the repository validates and saves the mapping, the Designer does not validate
whether the stored procedure expression runs without an error. If the stored procedure
expression is not configured properly, the session fails. When testing a mapping using a
stored procedure, set the Override Tracing session option to a verbose mode and
configure the On Stored Procedure session option to stop running if the stored procedure
fails. Configure these session options on the Error Handling settings of the Config
Object tab in the session properties.
You lose output parameters or return values called during pre- or post-session stored
procedures, since there is no place to capture the values. If you need to capture values, you
might want to configure the stored procedure to save the value in a table in the database.
348 Chapter 16: Stored Procedure Transformation
Error Handling
Sometimes a stored procedure returns a database error, such as “divide by zero” or “no more
rows”. The final result of a database error during a stored procedure differs depending on
when the stored procedure takes place and how the session is configured.
You can configure the session to either stop or continue running the session upon
encountering a pre- or post-session stored procedure error. By default, the PowerCenter Server
stops a session when a pre- or post-session stored procedure database error occurs.
Figure 16-3 shows the properties you can configure for stored procedures and error handling:
Figure 16-3. Stored Procedure Error Handling
Stored
Procedure Error
Handling
Pre-Session Errors
Pre-read and pre-load stored procedures are considered pre-session stored procedures. Both
run before the PowerCenter Server begins reading source data. If a database error occurs
during a pre-session stored procedure, the PowerCenter Server performs a different action
depending on the session configuration.
♦ If you configure the session to stop upon stored procedure error, the PowerCenter Server
fails the session.
♦ If you configure the session to continue upon stored procedure error, the PowerCenter
Server continues with the session.
Error Handling 349
Post-Session Errors
Post-read and post-load stored procedures are considered post-session stored procedures. Both
run after the PowerCenter Server commits all data to the database. If a database errors during
a post-session stored procedure, the PowerCenter Server performs a different action
depending on the session configuration.
♦ If you configure the session to stop upon stored procedure error, the PowerCenter Server
fails the session.
However, the PowerCenter Server has already committed all data to session targets.
♦ If you configure the session to continue upon stored procedure error, the PowerCenter
Server continues with the session.
Session Errors
Connected or unconnected stored procedure errors occurring during the session itself are not
affected by the session error handling option. If the database returns an error for a particular
row, the PowerCenter Server skips the row and continues to the next row. As with other row
transformation errors, the skipped row appears in the session log.
350 Chapter 16: Stored Procedure Transformation
Supported Databases
The supported options for Oracle, and other databases, such as Informix, Microsoft SQL
Server, and Sybase are described below. For more information about database differences, see
“Writing a Stored Procedure” on page 332. Also see your database documentation for more
details on supported features.
SQL Declaration
In the database, the statement that creates a stored procedure appears similar to the following
Oracle stored procedure:
create or replace procedure sp_combine_str
(str1_inout IN OUT varchar2,
str2_inout IN OUT varchar2,
str_out OUT varchar2)
is
begin
str1_inout := UPPER(str1_inout);
str2_inout := upper(str2_inout);
str_out := str1_inout || ' ' || str2_inout;
end;
In this case, the Oracle statement begins with CREATE OR REPLACE PROCEDURE. Since
Oracle supports both stored procedures and stored functions, only Oracle uses the optional
CREATE FUNCTION statement.
Parameter Types
There are three possible parameter types in stored procedures:
♦ IN. Defines the parameter something that must be passed to the stored procedure.
♦ OUT. Defines the parameter as a returned value from the stored procedure.
♦ INOUT. Defines the parameter as both input and output. Only Oracle supports this
parameter type.
Input/Output Port in Mapping
Since Oracle supports the INOUT parameter type, a port in a Stored Procedure
transformation can act as both an input and output port for the same stored procedure
parameter. Other databases should not have both the input and output check boxes selected
for a port.
Supported Databases 351
Type of Return Value Supported
Different databases support different types of return value datatypes, and only Informix does
not support user-defined return values.
352 Chapter 16: Stored Procedure Transformation
Expression Rules
Unconnected Stored Procedure transformations can be called from an expression in another
transformation. Use the following rules and guidelines when configuring the expression:
♦ A single output parameter is returned using the variable PROC_RESULT.
♦ When you use a stored procedure in an expression, use the :SP reference qualif