(version 9.6.0) informatica b2b data transformation...powermart, metadata manager, informatica data...

Informatica B2B Data Transformation (Version 9.6.0)

Administrator Guide

Informatica B2B Data Transformation Administrator Guide

Version 9.6.0January 2014

Copyright (c) 2001-2014 Informatica Corporation. All rights reserved.

This software and documentation contain proprietary information of Informatica Corporation and are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright law. Reverse engineering of the software is prohibited. No part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica Corporation. This Software may be protected by U.S. and/or international Patents and other Patents Pending.

Use, duplication, or disclosure of the Software by the U.S. Government is subject to the restrictions set forth in the applicable software license agreement and as provided in DFARS 227.7202-1(a) and 227.7702-3(a) (1995), DFARS 252.227-7013©(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14 (ALT III), as applicable.

The information in this product or documentation is subject to change without notice. If you find any problems in this product or documentation, please report them to us in writing.

Informatica, Informatica Platform, Informatica Data Services, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerExchange, PowerMart, Metadata Manager, Informatica Data Quality, Informatica Data Explorer, Informatica B2B Data Transformation, Informatica B2B Data Exchange Informatica On Demand, Informatica Identity Resolution, Informatica Application Information Lifecycle Management, Informatica Complex Event Processing, Ultra Messaging and Informatica Master Data Management are trademarks or registered trademarks of Informatica Corporation in the United States and in jurisdictions throughout the world. All other company and product names may be trade names or trademarks of their respective owners.

Portions of this software and/or documentation are subject to copyright held by third parties, including without limitation: Copyright DataDirect Technologies. All rights reserved. Copyright © Sun Microsystems. All rights reserved. Copyright © RSA Security Inc. All Rights Reserved. Copyright © Ordinal Technology Corp. All rights reserved.Copyright © Aandacht c.v. All rights reserved. Copyright Genivia, Inc. All rights reserved. Copyright Isomorphic Software. All rights reserved. Copyright © Meta Integration Technology, Inc. All rights reserved. Copyright © Intalio. All rights reserved. Copyright © Oracle. All rights reserved. Copyright © Adobe Systems Incorporated. All rights reserved. Copyright © DataArt, Inc. All rights reserved. Copyright © ComponentSource. All rights reserved. Copyright © Microsoft Corporation. All rights reserved. Copyright © Rogue Wave Software, Inc. All rights reserved. Copyright © Teradata Corporation. All rights reserved. Copyright © Yahoo! Inc. All rights reserved. Copyright © Glyph & Cog, LLC. All rights reserved. Copyright © Thinkmap, Inc. All rights reserved. Copyright © Clearpace Software Limited. All rights reserved. Copyright © Information Builders, Inc. All rights reserved. Copyright © OSS Nokalva, Inc. All rights reserved. Copyright Edifecs, Inc. All rights reserved. Copyright Cleo Communications, Inc. All rights reserved. Copyright © International Organization for Standardization 1986. All rights reserved. Copyright © ej-technologies GmbH. All rights reserved. Copyright © Jaspersoft Corporation. All rights reserved. Copyright © is International Business Machines Corporation. All rights reserved. Copyright © yWorks GmbH. All rights reserved. Copyright © Lucent Technologies. All rights reserved. Copyright (c) University of Toronto. All rights reserved. Copyright © Daniel Veillard. All rights reserved. Copyright © Unicode, Inc. Copyright IBM Corp. All rights reserved. Copyright © MicroQuill Software Publishing, Inc. All rights reserved. Copyright © PassMark Software Pty Ltd. All rights reserved. Copyright © LogiXML, Inc. All rights reserved. Copyright © 2003-2010 Lorenzi Davide, All rights reserved. Copyright © Red Hat, Inc. All rights reserved. Copyright © The Board of Trustees of the Leland Stanford Junior University. All rights reserved. Copyright © EMC Corporation. All rights reserved. Copyright © Flexera Software. All rights reserved. Copyright © Jinfonet Software. All rights reserved. Copyright © Apple Inc. All rights reserved. Copyright © Telerik Inc. All rights reserved. Copyright © BEA Systems. All rights reserved. Copyright © PDFlib GmbH. All rights reserved. Copyright ©

Orientation in Objects GmbH. All rights reserved. Copyright © Tanuki Software, Ltd. All rights reserved. Copyright © Ricebridge. All rights reserved. Copyright © Sencha, Inc. All rights reserved.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/), and/or other software which is licensed under various versions of the Apache License (the "License"). You may obtain a copy of these Licenses at http://www.apache.org/licenses/. Unless required by applicable law or agreed to in writing, software distributed under these Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.

This product includes software which was developed by Mozilla (http://www.mozilla.org/), software copyright The JBoss Group, LLC, all rights reserved; software copyright © 1999-2006 by Bruno Lowagie and Paulo Soares and other software which is licensed under various versions of the GNU Lesser General Public License Agreement, which may be found at http:// www.gnu.org/licenses/lgpl.html. The materials are provided free of charge by Informatica, "as-is", without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose.

The product includes ACE(TM) and TAO(TM) software copyrighted by Douglas C. Schmidt and his research group at Washington University, University of California, Irvine, and Vanderbilt University, Copyright (©) 1993-2006, all rights reserved.

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (copyright The OpenSSL Project. All Rights Reserved) and redistribution of this software is subject to terms available at http://www.openssl.org and http://www.openssl.org/source/license.html.

This product includes Curl software which is Copyright 1996-2013, Daniel Stenberg, <[email protected]>. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://curl.haxx.se/docs/copyright.html. Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

The product includes software copyright 2001-2005 (©) MetaStuff, Ltd. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://www.dom4j.org/ license.html.

The product includes software copyright © 2004-2007, The Dojo Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://dojotoolkit.org/license.

This product includes ICU software which is copyright International Business Machines Corporation and others. All rights reserved. Permissions and limitations regarding this software are subject to terms available at http://source.icu-project.org/repos/icu/icu/trunk/license.html.

This product includes software copyright © 1996-2006 Per Bothner. All rights reserved. Your right to use such materials is set forth in the license which may be found at http:// www.gnu.org/software/ kawa/Software-License.html.

This product includes OSSP UUID software which is Copyright © 2002 Ralf S. Engelschall, Copyright © 2002 The OSSP Project Copyright © 2002 Cable & Wireless Deutschland. Permissions and limitations regarding this software are subject to terms available at http://www.opensource.org/licenses/mit-license.php.

This product includes software developed by Boost (http://www.boost.org/) or under the Boost software license. Permissions and limitations regarding this software are subject to terms available at http:/ /www.boost.org/LICENSE_1_0.txt.

This product includes software copyright © 1997-2007 University of Cambridge. Permissions and limitations regarding this software are subject to terms available at http:// www.pcre.org/license.txt.

This product includes software copyright © 2007 The Eclipse Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http:// www.eclipse.org/org/documents/epl-v10.php and at http://www.eclipse.org/org/documents/edl-v10.php.

This product includes software licensed under the terms at http://www.tcl.tk/software/tcltk/license.html, http://www.bosrup.com/web/overlib/?License, http://www.stlport.org/doc/ license.html, http:// asm.ow2.org/license.html, http://www.cryptix.org/LICENSE.TXT, http://hsqldb.org/web/hsqlLicense.html, http://httpunit.sourceforge.net/doc/ license.html, http://jung.sourceforge.net/license.txt , http://www.gzip.org/zlib/zlib_license.html, http://www.openldap.org/software/release/

license.html, http://www.libssh2.org, http://slf4j.org/license.html, http://www.sente.ch/software/OpenSourceLicense.html, http://fusesource.com/downloads/license-agreements/fuse-message-broker-v-5-3- license-agreement; http://antlr.org/license.html; http://aopalliance.sourceforge.net/; http://www.bouncycastle.org/licence.html; http://www.jgraph.com/jgraphdownload.html; http://www.jcraft.com/jsch/LICENSE.txt; http://jotm.objectweb.org/bsd_license.html; . http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231; http://www.slf4j.org/license.html; http://nanoxml.sourceforge.net/orig/copyright.html; http://www.json.org/license.html; http://forge.ow2.org/projects/javaservice/, http://www.postgresql.org/about/licence.html, http://www.sqlite.org/copyright.html, http://www.tcl.tk/software/tcltk/license.html, http://www.jaxen.org/faq.html, http://www.jdom.org/docs/faq.html, http://www.slf4j.org/license.html; http://www.iodbc.org/dataspace/iodbc/wiki/iODBC/License; http://www.keplerproject.org/md5/license.html; http://www.toedter.com/en/jcalendar/license.html; http://www.edankert.com/bounce/index.html; http://www.net-snmp.org/about/license.html; http://www.openmdx.org/#FAQ; http://www.php.net/license/3_01.txt; http://srp.stanford.edu/license.txt; http://www.schneier.com/blowfish.html; http://www.jmock.org/license.html; http://xsom.java.net; http://benalman.com/about/license/; https://github.com/CreateJS/EaselJS/blob/master/src/easeljs/display/Bitmap.js; http://www.h2database.com/html/license.html#summary; http://jsoncpp.sourceforge.net/LICENSE; http://jdbc.postgresql.org/license.html; http://protobuf.googlecode.com/svn/trunk/src/google/protobuf/descriptor.proto; https://github.com/rantav/hector/blob/master/LICENSE; http://web.mit.edu/Kerberos/krb5-current/doc/mitK5license.html. and http://jibx.sourceforge.net/jibx-license.html.

This product includes software licensed under the Academic Free License (http://www.opensource.org/licenses/afl-3.0.php), the Common Development and Distribution License (http://www.opensource.org/licenses/cddl1.php) the Common Public License (http://www.opensource.org/licenses/cpl1.0.php), the Sun Binary Code License Agreement Supplemental License Terms, the BSD License (http:// www.opensource.org/licenses/bsd-license.php), the new BSD License (http://opensource.org/licenses/BSD-3-Clause), the MIT License (http://www.opensource.org/licenses/mit-license.php), the Artistic License (http://www.opensource.org/licenses/artistic-license-1.0) and the Initial Developer’s Public License Version 1.0 (http://www.firebirdsql.org/en/initial-developer-s-public-license-version-1-0/).

This product includes software copyright © 2003-2006 Joe WaInes, 2006-2007 XStream Committers. All rights reserved. Permissions and limitations regarding this software are subject to terms available at http://xstream.codehaus.org/license.html. This product includes software developed by the Indiana University Extreme! Lab. For further information please visit http://www.extreme.indiana.edu/.

This product includes software Copyright (c) 2013 Frank Balluffi and Markus Moeller. All rights reserved. Permissions and limitations regarding this software are subject to terms of the MIT license.

This Software is protected by U.S. Patent Numbers 5,794,246; 6,014,670; 6,016,501; 6,029,178; 6,032,158; 6,035,307; 6,044,374; 6,092,086; 6,208,990; 6,339,775; 6,640,226; 6,789,096; 6,823,373; 6,850,947; 6,895,471; 7,117,215; 7,162,643; 7,243,110; 7,254,590; 7,281,001; 7,421,458; 7,496,588; 7,523,121; 7,584,422; 7,676,516; 7,720,842; 7,721,270; 7,774,791; 8,065,266; 8,150,803; 8,166,048; 8,166,071; 8,200,622; 8,224,873; 8,271,477; 8,327,419; 8,386,435; 8,392,460; 8,453,159; 8,458,230; and RE44,478, International Patents and other Patents Pending.

DISCLAIMER: Informatica Corporation provides this documentation "as is" without warranty of any kind, either express or implied, including, but not limited to, the implied warranties of noninfringement, merchantability, or use for a particular purpose. Informatica Corporation does not warrant that this software or documentation is error free. The information provided in this software or documentation may include technical inaccuracies or typographical errors. The information in this software and documentation is subject to change at any time without notice.

NOTICES

This Informatica product (the "Software") includes certain drivers (the "DataDirect Drivers") from DataDirect Technologies, an operating company of Progress Software Corporation ("DataDirect") which are subject to the following terms and conditions:

1.THE DATADIRECT DRIVERS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.

2. IN NO EVENT WILL DATADIRECT OR ITS THIRD PARTY SUPPLIERS BE LIABLE TO THE END-USER CUSTOMER FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR OTHER DAMAGES ARISING OUT OF THE USE OF THE ODBC DRIVERS, WHETHER OR NOT INFORMED OF THE POSSIBILITIES OF DAMAGES IN ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT LIMITATION, BREACH OF CONTRACT, BREACH OF WARRANTY, NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS.

Part Number: DT-ADM-96000-0001

Table of Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iiiInformatica Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Informatica My Support Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Informatica Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Informatica Web Site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Informatica How-To Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Informatica Knowledge Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv

Informatica Support YouTube Channel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv

Informatica Marketplace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv

Informatica Velocity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv

Informatica Global Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv

Chapter 1: System Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1System Administration Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Data Transformation System Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Backup Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Design Environment Backup Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Production Environment Backup Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Data Transformation Directory Locations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

User Permissions for Data Transformation Production Environment. . . . . . . . . . . . . . . . . . . . . . 4

User Permissions for Data Transformation Design Environment. . . . . . . . . . . . . . . . . . . . . . . . . 5

Administrator Task List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 2: Data Transformation Project Upgrading. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Data Transformation Project Upgrading Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

When to Upgrade Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Upgrade Terminology. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Upgrading a Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Upgrading a Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Syntax Conversion Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Pre-Upgrade Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Running the Syntax Conversion Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Running the Syntax Conversion Tool from the Command Line. . . . . . . . . . . . . . . . . . . . . . 11

Project Upgrade Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

New and Modified Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Modified Namespace for Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

XML Schemas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 3: Data Transformation System Configuration. . . . . . . . . . . . . . . . . . . . . . . . 14System Configuration Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Table of Contents i

Using the Configuration Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Configuration Settings Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 4: Event Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Using the Event Log for Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Log Generation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Log Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Engine Initialization Event Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

User Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

ii Table of Contents

PrefaceThe Data Transformation Administrator Guide is written for system administrators and users who are responsible for installing the Data Transformation software and maintaining or configuring its operation. It contains instructions and information for Linux, UNIX, and Windows platforms.

Informatica Resources

Informatica My Support PortalAs an Informatica customer, you can access the Informatica My Support Portal at http://mysupport.informatica.com.

The site contains product information, user group information, newsletters, access to the Informatica customer support case management system (ATLAS), the Informatica How-To Library, the Informatica Knowledge Base, Informatica Product Documentation, and access to the Informatica user community.

Informatica DocumentationThe Informatica Documentation team takes every effort to create accurate, usable documentation. If you have questions, comments, or ideas about this documentation, contact the Informatica Documentation team through email at [email protected]. We will use your feedback to improve our documentation. Let us know if we can contact you regarding your comments.

The Documentation team updates documentation as needed. To get the latest documentation for your product, navigate to Product Documentation from http://mysupport.informatica.com.

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

Informatica How-To LibraryAs an Informatica customer, you can access the Informatica How-To Library at http://mysupport.informatica.com. The How-To Library is a collection of resources to help you learn more about Informatica products and features. It includes articles and interactive demonstrations that provide

iii

http://mysupport.informatica.com

mailto:[email protected]


http://www.informatica.com


solutions to common problems, compare features and behaviors, and guide you through performing specific real-world tasks.

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

Informatica Support YouTube ChannelYou can access the Informatica Support YouTube channel at http://www.youtube.com/user/INFASupport. The Informatica Support YouTube channel includes videos about solutions that guide you through performing specific tasks. If you have questions, comments, or ideas about the Informatica Support YouTube channel, contact the Support YouTube team through email at [email protected] or send a tweet to @INFASupport.

Informatica MarketplaceThe Informatica Marketplace is a forum where developers and partners can share solutions that augment, extend, or enhance data integration implementations. By leveraging any of the hundreds of solutions available on the Marketplace, you can improve your productivity and speed up time to implementation on your projects. You can access Informatica Marketplace at http://www.informaticamarketplace.com.

Informatica VelocityYou can access Informatica Velocity at http://mysupport.informatica.com. Developed from the real-world experience of hundreds of data management projects, Informatica Velocity represents the collective knowledge of our consultants who have worked with organizations from around the world to plan, develop, deploy, and maintain successful data management solutions. If you have questions, comments, or ideas about Informatica Velocity, contact Informatica Professional Services at [email protected].

Informatica Global Customer SupportYou can contact a Customer Support Center by telephone or through the Online Support.

Online Support requires a user name and password. You can request a user name and password at http://mysupport.informatica.com.

The telephone numbers for Informatica Global Customer Support are available from the Informatica web site at http://www.informatica.com/us/services-and-training/support-services/global-support-centers/.

iv Preface


mailto:[email protected]

http://www.youtube.com/user/INFASupport

http://www.informaticamarketplace.com



http://www.informatica.com/us/services-and-training/support-services/global-support-centers/

C H A P T E R 1

System AdministrationThis chapter includes the following topics:

• System Administration Overview, 1

• Backup Policies, 2

• Data Transformation Directory Locations, 3

• User Permissions for Data Transformation Production Environment, 4

• User Permissions for Data Transformation Design Environment, 5

• Administrator Task List, 5

System Administration OverviewThe Data Transformation system consists of a design environment for designers and a production environment where applications run transformation services. For more information, see “Data Transformation System Architecture” on page 1.

The system administrator must regularly back up essential files for the operation of Data Transformation. For more information, see “Backup Policies” on page 2.

The files required for designing and running transformation projects and services are located in certain directories, which are determined at the time of installation. For more information, see “Data Transformation Directory Locations” on page 3.

Human users who use the Studio and application users that access services each must have the correct permissions. For more information, see “User Permissions for Data Transformation Production Environment” on page 4 and “User Permissions for Data Transformation Design Environment” on page 5.

For more information about the responsibilities of the system administrator, see “Administrator Task List” on page 5.

Data Transformation System ArchitectureThe Data Transformation network contains the following units:

• Design environment. One or more Windows computers on which the Data Transformation Studio is installed for use by designers. The design environment includes the following additional components:

- Data Transformation Engine. Tests transformation projects.

1

- Document processors. Convert documents from binary formats to formats that the Data Transformation Engine can read.

- Online documentation. Data Transformation product documentation.

On the design environment, you can install optional libraries of predefined transformations for use with industry messaging standards. For more information, see the Data Transformation Libraries Guide.

• Production environment. One or more Linux, UNIX, or Windows computers. Multiple production environments can be configured as a cluster if they are of the same type. The production environment contains the following components:

- Data Transformation Engine. Runs transformation services for applications.

- Document processors. Convert documents from binary formats to formats that the Data Transformation Engine can read.

Backup PoliciesMake regular backups of Data Transformation directories and files on both the production environment and the design environment.

Design Environment Backup PoliciesOn the Data Transformation Studio computer (design environment) of each developer in your organization, back up the following items:

• The Eclipse workspace directory.

• The Data Transformation configuration file (CMConfig.xml).

• The Data Transformation license file (CDELicense.cfg).

• The repository directory.

• The two directories that hold custom global components.

For more information about the locations of these items, see “Data Transformation Directory Locations” on page 3.

Production Environment Backup PoliciesOn the Data Transformation production environment computers in your organization, back up the following items:

• The Data Transformation configuration file (CMConfig.xml).

• The Data Transformation license file (CDELicense.cfg).

• The repository directory.

• The two directories that hold custom global components.

For more information about the locations of these items, see “Data Transformation Directory Locations” on page 3.

If you use identical configurations on multiple servers in a cluster, you need to back up only a single copy of these items.

2 Chapter 1: System Administration

Data Transformation Directory LocationsThe following table describes directories that are used by Data Transformation:

Location Description

<INSTALL_DIR> The directory where Data Transformation is installed. The user chooses this directory at the time of installation. The default is:- Windows. c:\Informatica\9.5.0- Linux and UNIX (root user). /root/Informatica/9.5.0

- Linux and UNIX (other user). /home/<user_name>/Informatica/9.5.0

<INSTALL_DIR>/DataTransformation/ The Data Transformation home directory, which contains the following files:- CMConfig.xml- CMConfig.xsd- CDELicense.cfg- setEnv.sh (Linux and UNIX)- setEnv.csh (Linux and UNIX)This value is stored in the IFCONTENTMASTER_HOME environment variable.

<INSTALL_DIR>/DataTransformation/bin/ Data Transformation executables.

<INSTALL_DIR>/DataTransformation/ServiceDB

Repository where transformation services are stored. This value is stored in CMConfig.xml and can be changed using the configuration editor or a text editor.

<INSTALL_DIR>/DataTransformation/CMReports

Engine and Studio logs. This value is stored in CMConfig.xml and can be changed using the configuration editor or a text editor.

<INSTALL_DIR>/DataTransformation/CMUserLogs

Application logs and user logs. This value is stored in CMConfig.xml and can be changed using the configuration editor or a text editor.

<INSTALL_DIR>/DataTransformation/autoInclude/user

The directory that holds custom global components (TGP files).

<INSTALL_DIR>/DataTransformation/externLibs/user

The directory that holds custom global components (DLL and JAR files).

<INSTALL_DIR>\clients\java\bin Java home directory (design environment).

<INSTALL_DIR>/java/bin Java home directory (production environment).

<INSTALL_DIR>\clients\java\jre\bin\client

JRE directory (design environment).

<INSTALL_DIR>/java/jre/bin/client JRE directory (production environment).

Data Transformation Directory Locations 3

Location Description

<INSTALL_DIR>/java/jre/lib/<processor><INSTALL_DIR>/java/jre/lib/<processor>/server

JRE directories (Linux and UNIX only). These values are stored in environment variables.

C:\Users\<USER_NAME>\My Documents\Informatica\DataTransformation\950\workspace

Eclipse workspace directory where projects are stored on the Studio computer. This location can be changed in the Studio using Eclipse commands.

There is also an optional, user-defined directory for diagnostic logs for the Server component that calls the Engine out of process. This path is stored in CMConfig.xml and can be changed using the configuration editor or a text editor.

Run the following command to determine the installation directory:

CM_console -vThe installation directory appears after Configuration file: and before /DataTransformation/.

For more information about environment variables and the configuration editor, see the Data Transformation Installation and Configuration Guide.

For more information about the Studio, see the Data Transformation Studio User Guide.

User Permissions for Data Transformation Production Environment

Windows administrator users have all permissions that are required for the Data Transformation production environment.

The following table describes the permissions required for Linux and UNIX users and Windows limited users to run the Engine in the production environment:

Directory Permissions

Installation directory Read

Installation directory Execute

Repository Read

Engine and Studio logs Read

Engine and Studio logs Write

Application logs and user logs Read

Application logs and user logs Write

For more information about the locations of these directories, see “Data Transformation Directory Locations” on page 3.


User Permissions for Data Transformation Design Environment

Windows administrator users have all permissions that are required for the Data Transformation design environment.

The following table describes the permissions that limited users require to design and test projects:

Directory Permissions

Installation directory Read

Installation directory Execute

Repository Read

Repository Write

Eclipse location Read

Eclipse location Write

Engine and Studio logs Read

Engine and Studio logs Write

To deploy projects to the repository on a remote computer, the limited user must have read and write permissions for the repository on that machine.

The following tasks require administrator permissions:

• Installing and uninstalling Data Transformation

• Installing libraries

• Changing Data Transformation configuration settings

For more information about the locations of these directories, see “Data Transformation Directory Locations” on page 3.

Administrator Task ListThe Data Transformation system administrator is responsible for the following tasks:

• Manage user permissions. For more information, see “User Permissions for Data Transformation Design Environment” on page 5 and “User Permissions for Data Transformation Production Environment” on page 4.

• Define a backup policy. For more information, see “Backup Policies” on page 2.

• Upgrade projects. For more information, see “Data Transformation Project Upgrading Overview” on page 7.

• Install, upgrade, configure, and uninstall Data Transformation. For more information, see the Data Transformation Installation and Configuration Guide.

User Permissions for Data Transformation Design Environment 5

• Install libraries. For more information, see the Data Transformation Libraries Guide.

• Deploy projects. For more information, see the Data Transformation Studio User Guide.


C H A P T E R 2

Data Transformation Project Upgrading

This chapter includes the following topics:

• Data Transformation Project Upgrading Overview, 7

• Syntax Conversion Tool, 9

• Project Upgrade Troubleshooting, 12

Data Transformation Project Upgrading OverviewIf you are upgrading from a previous Data Transformation release, you can upgrade your existing Studio projects and your deployed Data Transformation services to the current release.

The upgrade from Data Transformation version 3.2 or higher is automated.

• Individual project. Import it into Data Transformation Studio or open it.

• Multiple projects. Use the syntax conversion tool.

When to Upgrade ProjectsYou must upgrade projects when the syntax version changes for the Data Transformation Engine. The current version is 4.00.10.

To determine the syntax version, open a command prompt and run the following command:

CM_console -vThe syntax version appears.

Upgrade TerminologyData Transformation version 3.x used certain terms that have been superseded.

7

The following table describes the corresponding terms.

Current term Term Used in Data Transformation 3.x

Description

Project Workspace A directory on the Studio computer containing a transformation configuration: a CMW file, one or more TGP script files, and other related files.

Workspace No corresponding term

The parent directory on the Studio computer where Data Transformation Studio stores projects.

Deploy Publish Make a project available as a service.

Repository Services database location

The parent directory on the Studio computer and in the production environment where Data Transformation services are stored.

Note: This information is relevant for upgrading projects from Data Transformation 3.x to the current version.

Upgrading a ProjectOn a Windows computer where the design environment is installed, you can upgrade an individual project by importing it into Data Transformation Studio.

1. Click File > Import.

The Import dialog box appears.

2. Under the Data Transformation folder, select Import Data Transformation Project into Workspace, and then click Next.

The Import Data Transformation Project dialog box appears.

3. Click Browse to select the directory that contains the project you want to upgrade, and then click Next.

The Enter Project Name page appears.

4. Enter the name of the project as it will be displayed in the Data Transformation Explorer view, and then click Next.

The Import Files page appears.

5. Click Finish.

The project is imported and upgraded.

6. Test the project.

Upgrading a ServiceYou can upgrade the development copy of a project and re-deploy it as a Data Transformation service.

1. Open or import the project in Data Transformation Studio.

For more information, see “Upgrading a Project” on page 8.

2. Test the project.

3. Re-deploy the project.

For more information, see the Data Transformation Studio User Guide.

8 Chapter 2: Data Transformation Project Upgrading

Syntax Conversion ToolThe Data Transformation syntax conversion tool upgrades multiple projects and services simultaneously in one operation. It also upgrades global TGP script files, which are stored in the autoInclude/user directory.

Before the upgrade, the syntax conversion tool backs up existing projects and files. During the upgrade operation, it creates a log file that includes all errors detected.

In case of an error, restore the backup, correct the problem, and run the tool again.

Pre-Upgrade TasksBefore you run the syntax conversion tool to upgrade your projects and services, perform the following tasks:

1. Organize the projects and services correctly. For more information, see “Organize Projects and Services” on page 9.

2. Review and correct file names and directory names. For more information, see “ File and Directory Names from Data Transformation 3.x” on page 9.

3. Copy Data Transformation 3.x services on Linux and UNIX computers to a Windows computer. For more information, see “Syntax Conversion for Data Transformation 3.x on Linux or UNIX” on page 10.

Organize Projects and ServicesThe syntax conversion tool operates on a single parent directory that contains projects or services. It can operate on the following directories:

• A Data Transformation Studio workspace on the design environment computer.

• A Data Transformation repository on the production environment computer or the design environment computer.

• Any other directory that contains Data Transformation Studio projects or services.

• The Data Transformation autoInclude/user directory, which contains global TGP script files.

The project and service subdirectories must be at the top level of nesting under the parent directory, for example:

Workspace_Parent_Directory Project1 Project2 Project3 ...

or:

Repository_Parent_Directory Service1 Service2 Service3 ...

Tip: Move the files to a temporary directory before running the syntax conversion tool.

File and Directory Names from Data Transformation 3.xIn the current Data Transformation version, the names of project files and directories can contain only English letters (A-Z, a-z), numerals (0-9), spaces, and the following symbols:

# % & + , - . = @ [ ] _ { }If a version 3.x project does not conform with this convention, the project might fail to upgrade.

Syntax Conversion Tool 9

If you have projects from Data Transformation 3.x, change the file names and directory names to conform with the current naming convention.

Syntax Conversion for Data Transformation 3.x on Linux or UNIXThe syntax conversion tool only runs on Windows platforms.

1. Copy the service directories to a Windows computer.

2. Run the syntax conversion tool on the Windows copy of the service directories.

3. Re-deploy the services to the Linux or UNIX computer. For more information, see the Data Transformation Studio User Guide.

Running the Syntax Conversion ToolRun the syntax conversion tool on either of the following workspace and repository directories:

• The single parent directory that contains all projects or services.

• Individual parent directories, each containing a logical group of projects or services.

1. Open the syntax conversion tool. The following table describes the different actions you can perform to open the tool:

System Action

Windows Click Start > All Programs > Informatica > Data Transformation > Syntax Conversion Tool

LinuxUNIX

Run the following command:

<INSTALL_DIR>/DataTransformation/bin/CM_DBConverter.sh

The Syntax Conversion Tool window appears.

2. At the bottom of the window, select the version from which you are upgrading, such as 4.x.

On Linux or UNIX: The syntax conversion tool operates on Data Transformation version 4.x or later. For more information about upgrading from version 3.x, see “Syntax Conversion for Data Transformation 3.x on Linux or UNIX” on page 10.

3. On the Services tab, define the source and target locations. The following table describes the workspaces that you set in the service tab:

Option Description

Source Location The workspace containing the old projects or the repository containing the old services.

Target Location The workspace for the new projects or the repository for the new services. If the target is the same as the source, the original files are overwritten.


4. If you have any TGP files in the autoInclude/user directory, set option relevant s on the AutoInclude tab. The following table describes the locations to set in the AutoInclude tab:

Option Description

Source Location The old autoInclude/user directory.

Target Location The new autoInclude/user directory.

5. On the Result Files tab, set location options. The following table describes the locations to set:

Option Description

Backup Location The location where the tool backs up your existing projects prior to upgrade.

Error Location The location where the tool should store any projects that it cannot upgrade due to an error.

Log Location The location for the upgrade log.

6. Click Start.

The tool converts the projects and reports its progress and results.

7. Repeat steps 3, 5, and 6 on all Data Transformation Studio workspace parent directories that contain projects and repository parent directories that contain services.

The AutoInclude options should be blank on the repeat runs. The AutoInclude files are upgraded on the first run and do not need to be upgraded again.

8. If the tool reports any errors, review the log to determine their cause, correct them, and run the tool again.

9. Test the projects and services to confirm that they work correctly. For more information about issues that might arise, see “Project Upgrade Troubleshooting” on page 12.

Running the Syntax Conversion Tool from the Command LineTo run the syntax conversion tool from the command line:

1. Open a command prompt, and then change to the <INSTALL_DIR>/DataTransformation/bin/ directory.

2. The following table lists the commands to run:

Option Description

Windows CM_DBConverter.bat <switches>

LinuxUNIX

./CM_DBConverter.sh –console <switches>

Syntax Conversion Tool 11

The following table describes the <switches>:

Switch Required/Optional

Description

-v Required Major version from which you are upgrading, such as 4. On Linux and UNIX, upgrading is supported only from version 4 or later.

-s Required Path of the source directory, containing projects or services.

-d Optional Path of the target directory. If you omit this switch, the tool overwrites the existing directory.

-si Optional Path of the source autoInclude/user directory. If you omit this switch, the tool does not upgrade global TGP files.

-di Optional Path of the target autoInclude/user directory. If you omit this switch, the tool overwrites the existing directory.

-l Optional Path of the upgrade log file. The default is <INSTALL_DIR>/SyntaxConversionLog.txt.

-b Optional Path of the backup directory, where the tool backs up the original projects or services prior to the upgrade. The default is the value of the -s switch concatenated with the suffix _OLD_Backup.

-e Optional Path of the error directory, where the tool stores any projects or services that it cannot upgrade due to an error. The default is the value of the -s switch concatenated with the suffix _OLD_Failure.

After each switch, leave a space and type the value. If a path contains spaces, you must enclose it in quotation marks. For example, the following Windows command upgrades version 4 services in the default repository location:

CM_DBConverter.bat -v 4 -s "c:\Informatica\9.6.0\DataTransformation\ServiceDB"3. The tool notifies you when the upgrade is complete. If there are errors, it prompts you to examine the log

file.

4. If you are upgrading services, use the Configuration Editor to change the repository location to the target that you specified. For more information, see the Data Transformation Studio User Guide.

Project Upgrade TroubleshootingImportant: You must test the transformation following the upgrade to ensure that it performs according to its design.

If an upgraded project does not operate correctly, you can edit its configuration in Data Transformation Studio.


New and Modified ComponentsIf a Data Transformation component has been revised, renamed, or replaced by a new component, the upgrade installs the new component.

For more information about components that have been modified, see the Data Transformation Release Guide. In most cases, the modifications do not change the behavior of upgraded projects.

An upgraded project containing the Locator component might behave slightly differently from an original version 3.2 project, where the Locator component did not exist, and the analogous functionality was implemented in a different way.

In projects upgraded from version 4.0.4 and earlier, the behavior of the EnsureCondition and CalculateValue actions might change slightly due to the introduction of a new JavaScript processor. For more information about the JavaScript support in these actions, see the Data Transformation Studio User Guide.

For more information about behavior changes, see the Release Notes supplied with the new Data Transformation version.

Modified Namespace for VariablesStarting in version 4.0.6, the namespace for variables was changed to www.Local-Project.com/Variables. If you upgrade a project from version 4.0.5 or earlier, the Schema view and the project properties display both the old empty namespace and the new namespace that contains your variables. This does not affect the operation of your project.

XML SchemasIn Data Transformation 3.1, the XML schema was defined in the TGP files of the project. In Data Transformation 3.2 and later, the XML schema is an XSD file.

When you upgrade a version 3.1 project, Data Transformation Studio creates an XSD schema file. Review the schema and confirm that it meets your needs. You can edit the schema or create your own schema.

For more information about schemas, see the Data Transformation Studio User Guide.

Project Upgrade Troubleshooting 13

C H A P T E R 3

Data Transformation System Configuration

This chapter includes the following topics:

• System Configuration Overview, 14

• Using the Configuration Editor, 14

• Configuration Settings Reference, 15

System Configuration OverviewData Transformation stores the current configuration settings in the CMConfig.xml file. You can find the original configuration at time of installation in CMConfig.xml.backup. The location of these files is determined at time of installation. The default location is <INSTALL_DIR>/DataTransformation/.

To identify the installation directory, run the following command:

CM_console -vThe installation directory appears after Configuration file: and before /DataTransformation/.

In systems that require multiple configurations, additional copies of CMConfig.xml are located in the following directories:

• The directory pointed to by the IFConfigLocation4 environment variable on Windows machines.

• The /home directory of each user on Linux or UNIX systems.

You can modify the CMConfig.xml configuration file with the configuration editor or a text editor.

System environment variables also affect the functionality of Data Transformation. For more information, see Environment Variables Overview.

Using the Configuration EditorYou can use the configuration editor to change Data Transformation system settings.

14

To use the configuration editor on a Linux or UNIX computer, you must set the DISPLAY environment variable. For more information, see Linux and UNIX Environment Variable Reference.

1. In the <INSTALL_DIR>/DataTransformation directory, back up the CMConfig.xml configuration file.

2. Open the configuration editor by performing one of the following actions:

System Action

Windows Click Start > All Programs > Informatica 9.5.0 > Data Transformation > Configuration.

Linux Run the following command:

<INSTALL_DIR>/DataTransformation/CMConfig

UNIX Run the following command:

<INSTALL_DIR>/DataTransformation/CMConfig

3. In the tree in the left panel, select a parameter group.

The list of parameters in the group appears in the right panel. Read-only parameters are displayed on a gray background.

4. Perform one of the following actions:

Action Description

To add a new parameter

In the tree in the left panel, right-click a parameter group, click Add, and then select the parameter that you want to add.The parameter appears in the right panel.

To change the value of a parameter

Double-click the value in the right column, then type or select the new value. To change the value of a path variable, click the browse button, and then select the path.

To remove a parameter In the right panel, right-click the parameter, and then click Remove.Note: Some parameters cannot be removed.

5. Click the Save icon.

The changes are saved to CMConfig.xml.

6. Restart Data Transformation.

Configuration Settings ReferenceThe following tables describe the editable parameters as they appear in the tree in the configuration editor interface.

Configuration Settings Reference 15

CM Configuration

Parameter Description Default Value

file_format The version number of the configuration file format. Do not change this value unless instructed by Informatica Global Customer Support.

1001

xmlns:xsi The namespace of the XML schema language used in Data Transformation. The value is read-only.

http://www.w3.org/2001/XMLSchema-instance

xsi:noNamespaceSchemaLocation The file name of the schema for validating Data Transformation configuration files. The value is read-only.

CMConfig.xsd

CM Configuration > General


Minimum configuration refresh interval

The time interval, in microseconds, at which Data Transformation checks for system configuration updates.

36000000

Default code page The default working encoding of Studio projects. Windows_1252

CM log files directory The name of the log directory. Logs

Language ID The language of the user interface for the Studio, the configuration editor, and the syntax conversion tool.

en_US

CM Reports directory The path to the directory where the Engine stores event logs and reports.

<INSTALL_DIR>/DataTransformation/CMReports

User logs directory The path to the directory where the Engine stores user-defined logs.

<INSTALL_DIR>/DataTransformation/UserLogs

CM Configuration > General > Java


Home The path to the JRE that runs the Engine. <INSTALL_DIR>\clients\java\jre\bin

Maximum Heap Size

The maximum heap size, in megabytes, that the JRE can use. This value controls the maximum size of documents that can be processed by document processors. Do not change this value unless instructed by Informatica Global Customer Support.

64

16 Chapter 3: Data Transformation System Configuration

CM Configuration > CM Repository


mode The access mode of the repository. Do not change this value unless instructed by Informatica Global Customer Support.

FileSystem

CM Configuration > CM Repository > File System


Base Path The location of the repository where Data Transformation services are stored.

<INSTALL_DIR>/clients/DT/ServiceDB

CM Configuration > CM Engine


Days to keep history The number of days that the Engine saves event logs. 4

PreprocessorMaxBuf The maximum buffer size for input documents, in bytes. Do not change this value unless instructed by Informatica Global Customer Support.

5000000

Service refresh interval The time interval, in seconds, at which Data Transformation checks for repository updates such as new or revised services.

30

Reuse memory between requests

A memory allocation option. Do not change this value unless instructed by Informatica Global Customer Support.

true

JVM Location The location of the JRE (Windows only).Important: The configuration editor requires the JRE. If you edit this value, save the new setting and exit the configuration editor before you uninstall the previous JRE.

<INSTALL_DIR>\java\bin\client

Invocation The method of calling the Engine.- InProc. In-process- Server. Out-of-process

InProc

Disable concurrency Disables running the Engine in more than one thread. Do not change this value unless instructed by Informatica Global Customer Support.

false


CM Configuration > CM Engine > CM Server


Debug level The degree of verbosity of the CMServer diagnostic log.- 0. None- 1. Vital information only- 2. Invocation diagnostic information- 3, 4. Detailed diagnostic information- 5. Complete diagnostic information

n/a

Log location Path to the CMServer diagnostic log. n/a

Number of retries The maximum number of restarts permitted during the interval specified in Restart timeout . If a client process exceeds this number, it stops trying to restart the Engine.

4

Restart timeout The time interval in seconds during which restarts are counted. 900

Server Path The path to the CM_Server.sh shared object (Linux and UNIX only).

<INSTALL_DIR>/bin/cm_server.sh

Thread Pool Size The maximum number of Engine threads that can run client requests concurrently per process. If the number of client requests exceeds the number of available threads, the Server queues the requests until a thread is available.

4

CM Configuration > CM Engine > JVM Init Parameters


JVM parameter Initialization parameters for the JRE. You can add multiple parameters if required.

n/a

CM Libraries > HIPAA Validation


Url IP address or host name and port of the HIPAA Validation engine. n/a

CM Libraries > HIPAA Validation > RemoteWS


LocalPath Path of the HIPAA Validation engine as seen from the local computer. You cannot edit this parameter with the configuration editor.

n/a

RemotePath Path of the HIPAA Validation engine as seen from a remote computer. You cannot edit this parameter with the configuration editor.

n/a


CM Configuration > CM Studio > Eclipse


Workspace The Studio workspace directory path. Close the Studio before editing the path.

C:\Users\<USERNAME>\My Documents\Informatica\DataTransformation\910\workspace

Eclipse Command Line Parameters

A string of parameters that control the behavior of Eclipse.

n/a

Trace

Trace parameters appear under the nodes for CM Repository, CM Engine, System Utilities, and CM Agents. Trace parameters are used for troubleshooting. Do not edit them unless instructed by Informatica Global Customer Support.


Enabled Enables a debugging trace. Do not enable the trace unless instructed by Informatica.

false

Severity level The severity level of the trace messages:- ERROR- WARNING- INFORMATION

ERROR

Trace > Active Categories


Category The Data Transformation modules that generate trace messages. ENVIRONMENTEXECEXTERNALSFILESYSTEMINPUT_DOCINTERFACESNETWORKINGOUTPUT_DOCPREPROCESSOR_UNITREQUESTSYSTEMRESOURCESVIEWIO

Trace > Message Information


Process and threads Ids Includes the ID of processes and threads in the trace messages. true

Time stamp Includes the time stamp in the trace messages. true


Trace > Trace File


Trace file name Name of the trace file. CMEngine_log.txt

Maximum file size The maximum trace file size, in bytes. 1000000

Recycling method The method of file handling when the trace file reaches the maximum size:- Restart. Start a new file labeled with a timestamp.- Circular. The oldest messages are deleted to make room for new

messages.- None. Stops the trace.

Restart


C H A P T E R 4

Event LogsThis chapter includes the following topics:

• Using the Event Log for Troubleshooting, 21

• User Logs, 23

Using the Event Log for TroubleshootingThe main troubleshooting tool of Data Transformation Engine is the event log. The event log contains information about the operations that the software performs while processing a document.

Event logs can be generated both when you test a project in the Studio and when you run a service in the Engine. This chapter discusses some specific points about the Engine event logs.

For more information about using the event log for testing and debugging, see the Data Transformation Studio User Guide.

Log GenerationData Transformation Engine generates event logs when it encounters an error or failure while running a service.

The logs are stored in the CMReports directory.

• On Windows platforms, the default log location is the following directory:<INSTALL_DIR>\DataTransformation\CMReports\Logs

• On UNIX platforms, the default location is the following directory:<INSTALL_DIR>/CMReports/Logs

You can customize the location with the configuration editor.

Within this directory, the logs are organized by date and service name:

19Jan2004\Service1_A115656584-14611-19812-12403\events.cmeThe string A115656584-14611-19812-12403 is a GUID identifier.

To view a log, drag the *.cme file to the Events view of Data Transformation Studio.

In addition to the event log, Data Transformation Engine saves a copy of the source document in a subdirectory of the log directory. If you double-click an event in the log, the text that caused the event appears in the IntelliScript editor.

Note: If you use the CM_console command to run the Engine or if you test a project in the Studio, the logs are stored in the project Results directory, and not in the CMReports directory.

21

Disabling Very Large LogsData Transformation Studio can display event logs of up to approximately 300 MB. If a service generates logs that are larger than 300 MB, you can disable the log generation.

1. In Data Transformation Studio, open the original project from which you deployed the service.

2. Click Project > Properties > Output Control.

3. Deselect the option to Create Event Log.

4. Redeploy the service.

Log ConfigurationYou can configure the Engine event logs in the Data Transformation Configuration Editor. For more information on using the Configuration Editor, see the Data Transformation Installation and Configuration Guide.

Log LocationThe following table describes the settings in the Configuration Editor that you edit to change the log location:

Setting Description

CM Configuration/General/CM Reports directory

The path of the reports directory.If the Configuration Editor does not display this setting, you can add it by right-clicking the CM Configuration/General node, and click Add > CM Reports Directory. You can then enter the setting value.

CM Configuration/General/CM log files directory

Subdirectory of the reports directory, where Data Transformation stores the event logs. The default value is Logs.

Days to Keep HistoryData Transformation purges old Engine event logs and old copies of source documents periodically. The following table describes the parameter that configures log behavior:

Parameter Description

CM Configuration/CM Engine/Days to keep history

The number of days that Data Transformation saves event logs and user logs before purging. Default is 4.Only the log locations defined in the Configuration Editor are purged.

Multiple UsersIf Data Transformation Engine runs under multiple user accounts, the users' logs may overwrite each other, or it may be difficult to identify the logs belonging to a particular user. You can prevent this by configuring the users with different log locations. For more information about setting up multiple configurations, see the Data Transformation Installation and Configuration Guide.

22 Chapter 4: Event Logs

Engine Initialization Event LogIn addition to the logs of service events, there is an Engine initialization event log. This log records problems that occur when Data Transformation Engine starts, without reference to any service or input data. View this log to diagnose installation problems such as missing environment variables.

The initialization log is located in the CMReports\Init directory.

User LogsA transformation can output failure events to a user-defined log.

If an anchor fails to find text in the source document, it can write a message in the user log. This can occur even if the anchor is defined as optional, so that the failure does not terminate the transformation processing.

The user log can contain the following information:

• Failure level: Information, Warning, or Error

• Name of the component that failed

• Failure description

• Location of the failed component in the script

• Additional information about the transformation status, such as the values of data holders.

To define the user-log output, assign the on_fail property of the appropriate transformation components. For more information about the on_fail property and failure handling, see the Data Transformation Studio User Guide.

On Windows platforms, you can find the user log in the following directory:

<INSTALL_DIR>\DataTransformation\UserLogsOn Linux and UNIX platforms, you can find the user log in the following directory:

<INSTALL_DIR>/UserLogsYou can customize the location with the configuration editor.

By default, each execution of a transformation generates a user log having a unique name:

<service_name>+<unique_string>.logA transformation can set the user-log location at runtime by using SetValue actions to assign the following system variables. Set the phase property of SetValue to initial, ensuring that SetValue runs before any component that writes to the user log. For more information about SetValue, see the Data Transformation Studio User Guide.

Variable Description

VarServiceInfo/StandardError/StandardErrorDir Directory path of the user log

VarServiceInfo/StandardError/StandardErrorName File name of the user log

Data Transformation purges old user logs stored in the location that is defined in the Configuration Editor. If you store user logs in another location, Data Transformation does not purge them. For more information, see “Days to Keep History” on page 22.

User Logs 23

I N D E X

Aadministration

overview 1task list 5

architecture system 1

Bbackup policies

design environment 2production environment 2

CCalculateValue action

troubleshooting 13configuration

editing, using the configuration editor 14parameters, reference 15

configuration editor use 14

configuration file backup policies 2location 3

custom global components backup policies 2location of directories 3upgrading with syntax conversion tool 9

DData Transformation 3.1 on Linux or UNIX

syntax conversion patch 10days to keep history

event log 22deploy

defined 7design environment

backup policies 2defined 1permissions 5

directory locations 3troubleshooting names 9

EEclipse workspace directory

location 3

engine event log troubleshooting 21

EnsureCondition action troubleshooting 13

environment, design defined 1

environment, production defined 1

event log days to keep 22Engine initialization 23for multiple users 22troubleshooting 21

event logs configuration 22Engine 21when generated 21

FFailure logs

user-defined 23file and directory names

troubleshooting 9folder

locations 3

Gglobal components, custom

backup policies 2location of directories 3upgrading with syntax conversion tool 9

global TGP script files upgrading with syntax conversion tool 9

Hhome directory

location 3

Iinitialization

event log 23installation directory

location 3

24

JJava home directory

location 3JRE directory

location 3

Llicense file

backup policies 2location 3

Locator component troubleshooting 13

log directory location 3

log files user-defined 23

logs event 21

Ppermissions

design environment 5production environment 4Windows users 5

production environment backup policies 2defined 1permissions 4

project defined 7upgrade procedure 8upgrade task list 9upgrade troubleshooting 12upgrade, running the syntax conversion tool 10upgrade, running the syntax conversion tool from the command line 11upgrading from previous version 7upgrading with syntax conversion tool 9

projects directory location 3when to upgrade 7

publish defined 7

Rrepository

backup policies 2defined 7directory location 3

Sscript files, global TGP

backup policies 2upgrading with syntax conversion tool 9

service upgrade procedure 8

service (continued)upgrading with syntax conversion tool 9

services database defined 7

studio backup policies 2permissions 5

syntax conversion tool running 10running from the command line 11upgrading projects and services 9

system architecture 1

Ttask list

administration 5TGP script files, global

backup policies 2upgrading with syntax conversion tool 9

troubleshooting CalculateValue action 13EnsureCondition action 13file and directory names 9Locator component 13new and modified Data Transformation components 13project upgrading 12variable namespace 13

Uupgrade

terminology 7upgrading

overview, projects 7procedure 8running the syntax conversion tool 10running the syntax conversion tool from the command line 11schemas 13services and projects with syntax conversion tool 9task list 9troubleshooting 12when 7

user logs failures 23

user permissions 5

Vvariable namespace

troubleshooting 13

Wworkspace

backup policies 2defined 7directory location 3

Index 25