infosphere mdm collaboration server: migration guide · vi infosphere mdm collaboration server:...

IBM InfoSphere Master Data Management CollaborationServer

Migration GuideVersion 10 Release 0

SC19-3498-00

��

NoteBefore using this information and the product it supports, read the information in “Notices” on page 79.

Edition notice

This edition applies to version 9, release 1, modification 0 of IBM InfoSphere Master Data Management Server forProduct Information Management (program number 5724-V51) and to all subsequent releases and modificationsuntil otherwise indicated in new editions.

© Copyright IBM Corporation 2000, 2011.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

Preface . . . . . . . . . . . . . . . vWhat's new in Version 10.0? . . . . . . . . . vContacting IBM Software Support . . . . . . . vi

Chapter 1. Migrating . . . . . . . . . 1

Chapter 2. Getting started . . . . . . . 3

Chapter 3. Migrating master data frominternal format to XML format . . . . . 5

Chapter 4. Migrating from prior versions 9Migrating from V5.3.2 to V10.0.0 . . . . . . . 12Migrating from V6.0.0 to V10.0.0 . . . . . . . 14Migrating from V9.0.0 to V10.0.0 . . . . . . . 16Migrating from V9.1.0 to V10.0.0 . . . . . . . 18Migrating Global Data Synchronization from V1.3.xto InfoSphere MDM Collaboration Server V10.0 . . 19

Preparing to migrate from GDS 1.3.x . . . . . 20Exporting from WebSphere Product CenterV5.2.1.4 . . . . . . . . . . . . . . . 26Importing to InfoSphere MDM CollaborationServer V10.0 . . . . . . . . . . . . . 34Verifying your migrated GDS environment . . . 40Compiling and debugging scripts . . . . . . 40

Chapter 5. Migrating InfoSphere MDMCollaboration Server scripts . . . . . 45Script differences in various versions . . . . . . 45

Methods with different signatures in V5.2.1 andV10.0.0 . . . . . . . . . . . . . . . 46Methods with different signatures in V5.3.0 andV5.3.0.1 . . . . . . . . . . . . . . . 48Methods with different signatures in V5.3.0.1 andV10.0.0 and later. . . . . . . . . . . . 48Methods with different signatures in V6.0.0 andV10.0.0 and later. . . . . . . . . . . . 49

Methods only in V5.2.1 . . . . . . . . . 49Methods only in V5.3.0.1 . . . . . . . . . 50Methods only in V9.0.0 carried forward toV10.0.0 . . . . . . . . . . . . . . . 50Methods only in V5.3.2 carried forward toV10.0.0 . . . . . . . . . . . . . . . 55Methods only in V6.5.0 carried forward toV10.0.0 . . . . . . . . . . . . . . . 59Changes in script operations behavior fromV5.2.1 and V10.0.0 . . . . . . . . . . . 59Changes in script operations behavior existingfrom V5.3.0.1 and V10.0.0. . . . . . . . . 62Changes in script operations behavior fromV6.0.0 and V10.0.0 . . . . . . . . . . . 64

Java API differences between various versions. . . 64Java API methods and enums . . . . . . . 64New Java API interfaces . . . . . . . . . 67

Tuning your database . . . . . . . . . . . 67Transforming the data model metadata . . . . . 67XSLT transformer corrections . . . . . . . . 68Manually migrating your scripts . . . . . . . 71

Chapter 6. Troubleshooting . . . . . . 73Troubleshooting the migration scripts. . . . . . 73

Using compiled migration scripts . . . . . . 73Common script compilation errors. . . . . . 73Common runtime errors and problems . . . . 74Resolving runtime errors and problems . . . . 75Using checkForCompileError.sh . . . . . . 76

Troubleshooting migration issues . . . . . . . 76

Notices . . . . . . . . . . . . . . 79Trademarks . . . . . . . . . . . . . . 81

Index . . . . . . . . . . . . . . . 83

© Copyright IBM Corp. 2000, 2011 iii

iv InfoSphere MDM Collaboration Server: Migration Guide

Preface

This information will help you to migrate from IBM® InfoSphere® Master DataManagement Collaboration Server V5.2.1 to V6.0.0, Fix Pack 9 to V9.1.0, V5.3.0 toV6.0.0, Fix Pack 9 to V9.1.0, V5.3.2, Fix Pack 17 to V9.1.0. V6.0.0, Fix Pack 9 toV9.1.0, and V9.0.0, Fix Pack 5 to V9.1.0.

About this publication

The following information covers step-by-step instructions, best practices,performance tuning, and troubleshooting common issues.

Intended audience

This migration guide is intended for installers, system administrators, and IBMProfessional Services personnel to successfully deploy the product in yourenvironment.

Prerequisite and related information

Before using this migration guide, become familiar with the following information:v InfoSphere MDM Collaboration Server information centerv Your application server documentationv Your database software documentation

How to send your comments

Your feedback is important in helping to provide the most accurate andhigh-quality information. If you have any comments about this book or any otherInfoSphere MDM Collaboration Server documentation, use the following form tosend us your comments:

http://www.ibm.com/software/data/rcf/

What's new in Version 10.0?There are many new features and functions in IBM InfoSphere Master DataManagement Collaboration Server Version 10.0.

InfoSphere MDM Collaboration Server is included in InfoSphere MDM EnterpriseEdition and InfoSphere MDM Collaborative Edition.

InfoSphere MDM Collaboration Server enables companies to create a single,up-to-date repository of product information that can be used throughout theirorganization for strategic business initiatives.

Key changes to the product include:

Content Management Solution integrationAttribute Value Synchronization between InfoSphere MDM CollaborationServer and Content Management Solution Integration. See Contentmanagement configuration files for more information.

© Copyright IBM Corp. 2000, 2011 v

http://www.ibm.com/software/data/rcf/

Administration enhancementsSystem administration enhancements and serviceability enhancements forlog collecting. See Log files for more information.

Performance best practicesIdentified best practices from enhancing good performance. See Enhancinggood performance for more information.

Migration support for InfoSphere MDM Collaboration Server users

v Migrating from V5.3.2, Fix Pack 18 to V10.0.0v Migrating from V6.0.0, Fix Pack 11 to V10.0.0v Migrating from V9.0.0, Fix Pack 7 to V10.0.0v Migrating from V9.1.0, Fix Pack 1 to V10.0.0

Migration support for Global Data Synchronization users

v Migration from Global Data Synchronization version 1.3.x to InfoSphereMDM Collaboration Server version 10.0

Invoking Java API from scriptingThe following tasks are documented to support the use of the Java API:v How to obtain access to the current context in the Java API code when

invoked from scripting.v How to pass arguments and obtain return values, including any

restrictions on what type of arguments can be passed and returned.v All other special considerations and restrictions to be aware of.v Lists of example code.

Contacting IBM Software SupportIBM Software Support provides assistance with product defects, answering FAQs,and performing rediscovery.

Before you begin

After trying to find your answer or solution by using other self-help options suchas technotes, you can contact IBM Support. Before contacting IBM Support, yourcompany must have an active IBM maintenance contract, and you must beauthorized to submit problems to IBM. For information about the types ofavailable support, see the Support portfolio topic in the Software Support Handbook.

When contacting IBM Software Support it is important to understand whatsupport is available through IBM:v Specific product questions: If you have been trained on the product, you can

submit specific questions or concerns.v Defect support: The analysis and necessary work required to resolve a product

defect or provide a workaround.v Script operations: For questions regarding a script operation or for reporting a

possible defect with a script operation, you must simplify your question orproblem to approximately 5 lines of code or less.– IBM does not provide support for debugging and analysis of custom scripts.

v Enhancement requests: Requests for new functionality added to the product.

Requests that are not within the scope of IBM Software Support and require you tocontact either your Sales or Professional Services representative:

vi InfoSphere MDM Collaboration Server: Migration Guide

http://www14.software.ibm.com/webapp/set2/sas/f/handbook/offerings.html

v Miscellaneous work: Work or assistance that requires extensive IBM involvementduring installation or the implementation process which includes complexinstallations or installation across multiple platforms.

v Support for untrained customers: Requests for step by step IBM help but do nothave the required IBM product training. IBM Education offers customer trainingif additional staff training is needed. Check the IBM Web site for specificinformation about available courses.

v Custom scripts or scripting: No support is provided for scripts that you havewritten or require debugging. All customized scripts written by ProfessionalServices become owned and maintained by you, the customer, after Service'swork has been completed. Technical Support is not available for writing ordebugging custom scripts.

v Data recovery: We strongly advise you to routinely backup your data.v Performance or tuning assistance or recommendations that require customer

data.

Procedure1. Determine if a technote already exists regarding your issue. For additional

information on viewing technotes, see Searching knowledge bases.2. Determine whether a peer or your internal support team can provide

assistance.3. Define the problem, gather background information, and determine the severity

of the problem. For help, see the “Before contacting IBM Software Support” inthe Software Support Handbook.

Required background information

v All configuration settings and information.v The expected behavior versus what the current behavior is.v All changes or modification that you have recently implemented.v Determine if the issue can be recreated.v Define the steps that lead to the issues you are experiencing.

4. Gather your diagnostic information:v You can also use the IBM Support Assistant basic data collection feature to

collect your critical log and configuration files, see www.ibm.com/software/support/isa/ for additional information.

v Create your own IBM Support Assistant Lite collector tool through theworkbench.a. Download the product add-on in the IBM Support Assistant workbench.b. Click Collect and Send Data. Three options display on the left.c. Choose ...Using IBM Support Assistant Lite.d. Create the generated collector by completing each of the collector options:

– Select a collector (if the installed product add-on does not display, itdoes not have a Must Gather document and cannot create an IBMSupport Assistant Lite collector)

– Specify the target directory– Specify the filename– Click the Export button

e. Transfer the exported IBM Support Assistant Lite collector to a remotesystem using ftp or any other available file transfer protocol.

Preface vii

http://www14.software.ibm.com/webapp/set2/sas/f/handbook/getsupport.html#1

http://www.ibm.com/software/support/isa/

http://www.ibm.com/software/support/isa/

f. Unzip the exported IBM Support Assistant Lite collector to your targetlocation.

g. Setup JAVA_HOME or ensure that Java™ is in your path statement.h. Run the runISALite.bat command for Windows or the runISALite.sh

script for UNIX and LINUX from the tools IBM Support Assistant Litedirectory on the remote system.

i. Provide the appropriate responses to any collection prompts.j. Review the collected files or send them to IBM support.

5. Submit your problem to IBM Software Support in one of the following ways:v Online: (Recommended)

a. Click Open service request given under the Choose your task section onthe left-side navigation bar of the IBM InfoSphere Master DataManagement Collaboration Server Support site.

b. Click ESR / SR and follow the instructions provided on the ESR Web site.Use the following guidelines and tips for using ESR and submittingPMRs:– Attach documents directly to the PMR to make them available to IBM

Support Services.– ESR manages a list of all PMRs that you have viewed so that you have

immediate access to them to check on their status.– Use ESR to set up automatic PMR notifications.– Send updates for PMR's that you open to IBM Support Services

directly from ESR.– When submitting a PMR you must indicate a severity level in order to

help us prioritize our resources with respect to other PMRs you open:

Severity 1Critical business impact: This indicates that you are unable touse the program resulting in a critical impact on operations.This condition requires an immediate solution.

Note: Critical business impact typically means that yourproduction system is down and in order for IBM SoftwareSupport to work outside of your business working hours, youmust ensure that you have a contact available by phone 24x7to facilitate inquiries by the investigating engineer, run tests inyour production instance, etc.

Severity 2Significant business impact: This indicates the program isusable but severely limited.

Severity 3Some business impact: This indicates the program is usablewith less significant features (not critical to operations)unavailable.

Severity 4Minimal business impact: This indicates the problem causeslittle impact on operations or that a reasonable circumventionto the problem has been implemented.

– To open an Enhancement Request (a request for new general productfunctionality and is not related to a specific customization):

viii InfoSphere MDM Collaboration Server: Migration Guide

http://www.ibm.com/support/entry/portal/Overview/Software/Information_Management/InfoSphere_Master_Data_Management_Server_for_Product_Information_Management

- Open a PMR with severity 2, 3, or 4, (depending of the potentialbusiness gain of the request) and the request is sent to IBM ProductManagement for review. You will receive an Enhancement Requestnumber for tracking purposes, which replaces the PMR number.Typically, your approval is required to close the PMR.

v By phone: For the phone number to call in your country, go to the Contactspage of the Software Support Handbook.

What to do next

If the problem you submit is for a software defect or for missing or inaccuratedocumentation, IBM Software Support creates an Authorized Program AnalysisReport (APAR). The APAR describes the problem in detail. Whenever possible,IBM Software Support provides a workaround that you can implement until theAPAR is resolved and a fix is delivered. IBM publishes resolved APARs on theIBM Support Web site daily, so that other users who experience the same problemcan benefit from the same resolution.

Preface ix

http://www.software.ibm.com/webapp/set2/sas/f/handbook/contacts.html

http://www.software.ibm.com/webapp/set2/sas/f/handbook/contacts.html

x InfoSphere MDM Collaboration Server: Migration Guide

Chapter 1. Migrating

If you are using an earlier version of IBM InfoSphere Master Data ManagementCollaboration Server, you can migrate from your version to the most currentversion.

This installation information is also available in the InfoSphere MDM CollaborationServer Migration Guide, which is available in book format in a PDF file. Right-clickon the link, and select Save Target As to download the PDF file to your computer.

© Copyright IBM Corp. 2000, 2011 1

2 InfoSphere MDM Collaboration Server: Migration Guide

Chapter 2. Getting started

You need to modify the database schema of your current installation usingmigration scripts for migrating from prior versions to IBM InfoSphere Master DataManagement Collaboration Server Version 10.0.

You must have adequate permissions to create and modify tables, and indexes inthe database. You must also have adequate permissions to create and delete files inthe subdirectories of the $TOP directory.

Migration involves the following basic steps:v Verify that enough database table space is available.v Stop the instance that is using the database schema.v Back up the existing database schema.v Install InfoSphere MDM Collaboration Server V10.0 and point to the same

database schema that the earlier instance was using.v Run the appropriate migration script to modify the database schema and bring it

to the InfoSphere MDM Collaboration Server V10.0 level.


Chapter 3. Migrating master data from internal format to XMLformat

You must convert master data to XML when migrating from prior versions to IBMInfoSphere Master Data Management Collaboration Server Version 10.0.0, Fix Pack1 and later fix packs.

Before you begin1. Create XML table spaces and buffer pools as described in the installation guide.2. Ensure that the database user for InfoSphere MDM Collaboration Server

application has appropriate database privileges as mentioned in the installationguide.

3. Stop the InfoSphere MDM Collaboration Server application on the local server.4. Run the delete_old_versions.sh script to delete all the old versions. Use your

company code and the current date as values for the code and end_dateparameters.

5. Optional - Enhance memory available to the Java process: Running the dataconversion script is a memory intensive process. It is recommended to provide2 GB of memory to the Java process by updating the custom_java_optionsparameter in the $TOP/bin/conf/env_settings.ini file. Run theconfigureEnv.sh after modifying the custom_java_options parameter to ensurethat the updated new memory settings come into effect.custom_java_options=-Xmx2048m -Xms256m

About this task

The data migration script requires twice the number of DB connections than thenumber of execution threads. For example, if you use 10 threads in thecommand-line option, then it requires 20 DB connections. You need to configurethe number of DB connections by using these two configuration parameters:v db_maxConnectionv db_maxConnection_default

Both the parameters are available in the common.properties file. If the values ofthese parameters are already equal to or greater than the required DB connections,then you do not need to change the values. If the values of these parameters areless than the required DB connections, then you must increase the values toimprove speed.

If you have more the 100,000 master data entries in the catalogs, increase thenumber threads. For example, you can use 50 or 100 threads to complete datamigration faster. The highest number of threads you can use depends on thefollowing variables in InfoSphere MDM Collaboration Server. You can evaluate theoptimum number of threads by running the migration script in a test environment.v Number of processor cores availablev Number of specs definedv Available memory

All the specs that are defined in InfoSphere MDM Collaboration Serverenvironment are retrieved and used in the data conversion process. If you have


more than 100 specs, update the spec caching parameters to appropriate values toprevent frequent database trips and improve overall script performance.

Procedure1. Get the spec count in InfoSphere MDM Collaboration Server by using the

following command.$PERL5LIB/runSQL.pl --sql_command="select count(*) from spc;"

2. Update these parameters with the values retrieved from the query in Step 1.These parameters are available in the mdm-cache-config.properties file in the$TOP/etc/default directory.specCache_KEY_START_VERSION_TO_VALUE.maxElementsInMemory=<spec count>

specCache_KEY_TO_CURRENT_START_VERSION.maxElementsInMemory=<spec count>

specCache_KEY_VERSION_TO_START_VERSION.maxElementsInMemory=<spec count>

Note: Running the configureEnv.sh script after updating themdm-cache-config.properties file overwrites the parameters with defaultvalues.

3. Run the data migration shell script, migrateDataToXml.sh. This file is in the$TOP/bin/migration directory.migrateDataToXml.sh --company=<company name> --threads=<number of threads>

where

--companySpecifies the company code that is used to log on to InfoSphere MDMCollaboration Server.

--threadsSpecifies the number of threads. Use a larger number of threads toimprove speed but ensure that enough DB connections exist. Thedefault is 1. It is recommended to provide at least 10 threads.

For example,migrateDataToXml.sh --company=ibm --threads=50

4. Run the migrateDataToXml.sh script with the xml_missing option. Running thescript should not return any item if the data migration is successful. In thisexample, the migrateDataToXml.sh script is run with the company nameparameter set to trigo.$TOP/bin/migration/migrateDataToXml.sh --company=trigo xml_missingEach ’#’ below represents 100 entries processed.Elapsed time = 0:0:1:766Log files in directory $TOP/logs/default

What to do next

You can verify that the script worked as intended by observing the errors that aredisplayed in the console and logged in thedefault.log file in the$TOP/logs/default directory. A list of entries that failed to migrate are displayed atthe end of execution.

The data migration script updates the database in batches. If there is an error, theentire batch is rolled back. Hence the number of entries that failed to migrate ismore than the actual failures. Update the index_regeneration_batch_sizeparameter value to 1 in the common.properties file, then run the data migration


script again to narrow down the entries with actual failures. A table of possiblereasons for errors during data migration and recommended actions is given:

Table 1. Possible reasons for errors and recommended actions

Reasons for error duringdata migration Recommended action

Data migration displays thefollowing error:

java.sql.SQLException: ORA-00600: internal error code, arguments: [KGHALP1], [0x000000000], [], [], [], [], [], [], [], [], [], []

Ensure that you are using the correct patch level for thedatabase. If required, upgrade the database then run thedata migration script again.

Data migration displays thefollowing error:

java.sql.SQLException: ORA-31061: XDB error: XML event errorORA-19202: Error occurred in XML processingIn line 46 of orastream:LPX-00241: entity reference is not well formed

One of the attribute values in the entry has the "&"character or an invalid value. Update the entry to removethe invalid value from the item edit interface of InfoSphereMDM Collaboration Server and then attempt datamigration again.

Chapter 3. Migrating master data from internal format to XML format 7

Chapter 4. Migrating from prior versions

You can migrate to IBM InfoSphere Master Data Management Collaboration ServerVersion 10.0.0, Fix Pack 1 from specific prior versions.

Four migration paths are supported for Version 10.0.0:v Migrating from V5.3.2, Fix Pack 18 to V10.0.0, Fix Pack 1.v Migrating from V6.0.0, Fix Pack 12 to V10.0.0, Fix Pack 1.v Migrating from V9.0.0, Fix Pack 7 to V10.0.0, Fix Pack 1.v Migrating from V9.1.0, Fix Pack 2 to V10.0.0, Fix Pack 1.

If you are migrating from an older fix pack version, ensure that you are not usingany deleted APIs in your Excel scripts. The following APIs have been removedfrom the latest POI jar file:v public String getExcelCellEncoding();v public void setEncoding(String encoding);v public String getExcelCellEncoding(Object cellObj) throws AustinException;

Restriction:

1. The support of InfoSphere MDM Collaboration Server Excel Parser is donethrough a third-party jar POI-3.2-FINAL .jar file. This jar file does not have a fixregarding the limitation on using more than 255 columns in a given row.

2. Excel 2010 .xlsx is not supported by this jar.

Important: Before running the migration scripts, you must ensure that you areusing the correct database version. See the system requirements page for details.You must also ensure that the InfoSphere MDM Collaboration Server database userhas appropriate privileges as mentioned in the installation guide. Consult withyour DBA team regarding any changes in database user privileges because of anysecurity policy.

You must use the DB2 or Oracle database version as mentioned in the systemrequirements page. You can refer to the DB2 or Oracle documentation forupgrading your DB2 and Oracle database to the supported version.

Notes for DB2 databases

If you are upgrading from an older version of DB2 to the supported version, youmust ensure that the CUR_COMMIT database configuration parameter is enabled. Youmust manually set this parameter because it is disabled by default for databasesthat are upgraded from older versions.

You must also have the database administrator execute the following SQLcommands before starting the migration of InfoSphere MDM Collaboration Server:

Important: If you are migrating from InfoSphere MDM Server for PIM V9.1.0FP002 to InfoSphere MDM Collaboration Server V10.0.0 FP001, do not executethese SQL commands.alter tablespace blob_tbl_data convert to large;alter tablespace blob_tbl_data file system caching


http://www-01.ibm.com/software/data/infosphere/mdm_server_pim/requirements.html



Steps for migrating InfoSphere MDM Collaboration Server when custom tablespaces are used in DB2 and Oracle

If you are using custom table space names instead of the default USERS or INDX,you must manually modify the table space names in following SQL files beforeyou start the migration to InfoSphere MDM Collaboration Server.

Table 2. WebSphere Product Center 5.3.2 Fix Pack 18

SQL files to modify when DB2 is theback-end database

SQL files to modify when Oracle is theback-end database

Modify the table space names from USERS,INDX and BLOB_TBL_DATA to appropriatecustom table space names in the followingSQL files in the $TOP/src/db/schema/dbscripts/db2 directory:create_new_tables_of_600.sqlcreate_new_tables_of_650.sqlcreate_new_tables_of_1000.sqlcreate_tables_of_gds.sqlwfd_pk.sqlstd_pk.sqlrecreate_coa_for_edit_flag.sqlmigrateItd.sqlmigrateDbl.sqlmigrateObh.sqlmigrateSst.sqlmigrateCad.sql

Modify the table space names from USERS,INDX and BLOB_TBL_DATA to appropriatecustom table space names in the followingSQL files in the $TOP/src/db/schema/dbscripts/oracle directory:create_new_tables_of_600.sqlcreate_new_tables_of_650.sqlcreate_new_tables_of_1000.sqlcreate_tables_of_gds.sqlwfd_pk.sqlstd_pk.sqlrecreate_coa_for_edit_flag.sqlmigrateItd.sqlmigrateDbl.sqlmigrateObh.sqmigrateSst.sqlmigrateCad.sql

Table 3. InfoSphere MDM Server for PIM 6.0.0 Fix Pack 12



Modify the table space names from USERS,INDX and BLOB_TBL_DATA to appropriatecustom table space names in the followingSQL files in the $TOP/src/db/schema/dbscripts/db2 directory:create_new_tables_of_650.sqlcreate_new_tables_of_1000.sqlcreate_tables_of_gds.sqlrecreate_coa_for_edit_flag.sqlmigrateItd.sqlmigrateDbl.sqlmigrateObh.sqlmigrateSst.sqlmigrateCad.sql

Modify the table space names from USERS,INDX and BLOB_TBL_DATA to appropriatecustom table space names in the followingSQL files in the $TOP/src/db/schema/dbscripts/oracle directory:create_new_tables_of_650.sqlcreate_new_tables_of_1000.sqlcreate_tables_of_gds.sqlrecreate_coa_for_edit_flag.sqlmigrateItd.sqlmigrateDbl.sqlmigrateObh.sqlmigrateSst.sqlmigrateCad.sql


Table 4. InfoSphere MDM Server for PIM 9.0 Fix Pack 7 and InfoSphere MDM Server forPIM 9.1 Fix Pack 2



Modify the table space names from USERS,INDX and BLOB_TBL_DATA to appropriatecustom table space names in the followingSQL files in the $TOP/src/db/schema/dbscripts/db2 directory:create_new_tables_of_1000.sqlmigrateItd.sqlmigrateDbl.sqlmigrateObh.sqlmigrateSst.sqlmigrateCad.sql

Modify the table space names from USERS,INDX and BLOB_TBL_DATA to appropriatecustom table space names in the followingSQL files in the $TOP/src/db/schema/dbscripts/oracle directory:create_new_tables_of_1000.sqlmigrateItd.sqlmigrateDbl.sqlmigrateObh.sqlmigrateSst.sqlmigrateCad.sql

You must verify that you have enough database tablespace available before youstart the migration. To calculate the additional space required forBLOB_TBL_DATA use the following queries:

For DB2select ’Extra space required for blob_tbl_data’,round(sum((npages * 16)/1024)) size_in_mbfrom syscat.tables where tabschema = current schemaand tabname in (’TCTG_ITD_ITEM_DETAIL’,’TDOC_DBL_DOC_BLOB’, ’TCTG_CAD_CATEGORY_DETAIL’,’TRSS_SST_SEARCH_TEMPLATE’, ’TAUD_OBH_OBJECT_HISTORY’)and npages is not nullunionselect ’SOME STATS NOT AVAILABLE’, 0from syscat.tables where tabschema = current schemaand tabname in (’TCTG_ITD_ITEM_DETAIL’,’TDOC_DBL_DOC_BLOB’, ’TCTG_CAD_CATEGORY_DETAIL’,’TRSS_SST_SEARCH_TEMPLATE’,’TAUD_OBH_OBJECT_HISTORY’)and npages is null;

For Oracleselect ’Extra space required for blob_tbl_data’,round(sum((blocks * 8)/1024)) size_in_mbfrom user_tableswhere table_name in (’TCTG_ITD_ITEM_DETAIL’,’TDOC_DBL_DOC_BLOB’, ’TCTG_CAD_CATEGORY_DETAIL’,’TRSS_SST_SEARCH_TEMPLATE’, ’TAUD_OBH_OBJECT_HISTORY’)and blocks is not nullUNIONselect ’SOME STATS NOT AVAILABLE’, 0from user_tableswhere table_name in (’TCTG_ITD_ITEM_DETAIL’,’TDOC_DBL_DOC_BLOB’, ’TCTG_CAD_CATEGORY_DETAIL’,’TRSS_SST_SEARCH_TEMPLATE’, ’TAUD_OBH_OBJECT_HISTORY’)and blocks is null;

Audit logs will not be migrated to V10.0.0. Because of a new format of audit logdescriptions introduced in V9.1.0, the audit log descriptions present in releasesprior to V9.1.0 will not be viewable in V10.0.0. Hence they will be deleted from thedatabase during the migration. The old audit logs can be viewed using the releasewhich you are migrating from.

You must manually perform the following steps to ensure successful migration:

Chapter 4. Migrating from prior versions 11

1. Manually migrate the property files mentioned below. Because property filesare part of the local file systems, the migration method does not supportexporting property files. Modify each of the customized property from theprevious releases to the corresponding file in the new version. Do not overwritethe property files from old version to new version since there are newparameters that have been introduced in V10.0.0. Refer to the InfoSphere MDMCollaboration Server documentation for details on each property file.v $TOP/etc/default/common.propertiesv $TOP/etc/default/logs.xmlv $TOP/etc/default/docstore_mount.xmlv $TOP/etc/default/user_jars.list

2. Manually copy the contents of the $TOP/public_html/suppliers/<cmpcode>/ctg_files directory to the new instance for each company. Because thesefiles are part of the local file system, the migration method does not supportexporting the ctg_files directory.

3. Manually add the required user .jar files to the new instance. Because thesefiles are part of the local file system, the migration method does not supportexporting user .jar files. For more information about adding .jar files to yourdeployment, see Deploying a custom user .jar file.

4. Manually redo any changes that you had made to the Default Rich SearchResults Report Script to customize it. Migrating to InfoSphere MDMCollaboration Server V10.0.0 overwrites the existing script available in theInfoSphere MDM Collaboration Server DocStore directory,/scripts/report.This script is used for exporting InfoSphere MDM Collaboration Server objectsearch results to an Excel sheet. For more information about this script, seeExporting search results to Excel.

5. Ensure that there is no verbose compilation option set for compiling scripts.Verify that in the common.properties file you do not use verbose as the value forthe script_compiler_options parameter. For more information about thisparameter, see script_compiler_options parameters.

6. Run the setup.sh script to check if the version of PERL installed on yourcomputer is compatible with the version of InfoSphere MDM CollaborationServer that you have installed. This script is located in the $TOP directory. If thecurrent version of PERL is not compatible, you must install a new version.

7. If you install the new version of InfoSphere MDM Collaboration Server in anew directory, you must update the value of TOP and PERL5LIB variables in the.bash_profile file. You must set the PERL5LIB variable to $TOP/bin/perllibdirectory.

Migrating from V5.3.2 to V10.0.0To migrate to IBM InfoSphere Master Data Management Collaboration ServerVersion 10.0.0, Fix Pack 1 from WebSphere® Product Center Version 5.3.2, you needto run the appropriate migration script.

Before you begin

Before you can migrate from WebSphere Product Center Version 5.3.2 to InfoSphereMDM Collaboration Server Version 10.0.0, you must ensure that you arespecifically using Fix Pack 18 for V5.3.2. If you are using V5.3.2 with any level offix pack from 1 through 17, you must migrate to V5.3.2, Fix Pack 18 following theinstructions in the WebSphere Product Center, Version 5.3.2, Fix Pack 18documentation.


ftp://ftp.software.ibm.com/software/websphere/wpc/fixpacks/5.3.2-FP018/WPC_ReleaseNotes_FixPack_18.html

You can configure the error log file location by modifying the _ERROR_LOGSvariable in the migrateFrom532FP.sh migration script. This variable is set to$TOP/logs/errfile.log by default.

If you use DB2® as the backend database, you must add new DB2 temporary tablespaces with 32K page size settings for InfoSphere MDM Collaboration Serverinstallations.1. Shutdown InfoSphere MDM Collaboration Server.2. Back up the DB2 database.3. Connect to the DB2 database that is used by InfoSphere MDM Collaboration

Server using the DB2 admin user ID4. Execute the following DB2 commands and ensure that they are completed

successfully. Modify the <db container path> in the following statements withthe correct file system path in your environment.db2 "CREATE BUFFERPOOL TEMPSYSBP32 SIZE AUTOMATIC PAGESIZE 32K"db2 "CREATE BUFFERPOOL TEMPUSRBP32 SIZE AUTOMATIC PAGESIZE 32K"db2 "CREATE USER TEMPORARY TABLESPACE TEMP_USER32 PAGESIZE 32K

MANAGED BY SYSTEM USING (’<db container path>’) EXTENTSIZE32 PREFETCHSIZE 32 BUFFERPOOL TEMPUSRBP32"

db2 "CREATE SYSTEM TEMPORARY TABLESPACE TEMP_SYSTEM32 PAGESIZE 32KMANAGED BY SYSTEM USING ’<db container path>’) EXTENTSIZE 32PREFETCHSIZE 32 BUFFERPOOL TEMPSYSBP32"

.

About this task

This is the only way to migrate from WebSphere Product Center V5.3.2 toInfoSphere MDM Collaboration Server Version 10.0.0 and no other means, such asusing the environment export and import tool, can be used for this migration.

Procedure1. Back up the existing database schema.2. Install InfoSphere MDM Collaboration Server V10.0.0, Fix Pack 1 into a

different directory.3. Set up your database.

a. For DB2 databases, create new bufferpools and table spaces as mentioned inSetting up your DB2 database in the installation guide.

Note: The size of the XML_DATA tablespace should be equal to the spaceoccupied by the TCTG_ITD_ITEM_DETAIL tablespace. You can find theapproximate size of the table by using the following query:select (fpages * 16) / 1024 megabytes from syscat.tableswhere tabschema = current schemaand tabname like ’TCTG_ITD_ITEM_DETAIL’;

b. For Oracle databases, create new table spaces and then install Oracle XMLDB component as mentioned in Setting up your Oracle database in theinstallation guide.

4. Point the InfoSphere MDM Collaboration Server V10.0.0, Fix Pack 1 instance tothe WebSphere Product Center Version 5.3.2, Fix Pack 18 database schema.

5. Run the migrateFrom532FP.sh migration script. This script is available in the$TOP/bin/migration directory.


6. Migrate your data as mentioned in Migrating master data from internal formatto XML format.

7. Start the InfoSphere MDM Collaboration Server V10.0.0, Fix Pack 1 instance.

Results

All messages, such as the status of individual migration components and theoverall migration summary, are displayed in the console.

After running the migration script, messages are displayed in the console thatindicate whether the migration succeeded or failed.

This message is displayed if the migration succeeded:-----------------------------------------------------------Summary of the migration-----------------------------------------------------------Migration to InfoSphere Master Data Management CollaborationServer 10.0.0 successful.

This message is displayed if the migration failed:!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!Migration Failed : xxxx!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!Please see the file for further details :/home/pimuser/mdmcs10/logs/errfile.log

This message is displayed if the migration of specific modules failed:-----------------------------------------------------------Summary of the migration-----------------------------------------------------------Migration of the following modules failed :<module names>

Review the errfile.log file for additional messages. For SQL errors, find thedetailed error message from the SQL error code, correct the error, and run themigration script again. For recommended action on migration failures, refer toTroubleshooting migration issues. Contact IBM Software Support if the problempersists after correcting the errors

Migrating from V6.0.0 to V10.0.0To migrate to IBM InfoSphere Master Data Management Collaboration ServerVersion 10.0.0, Fix Pack 1 from IBM® InfoSphere™ Master Data Management Serverfor Product Information Management Version 6.0.0, you need to run theappropriate migration script.

Before you begin

Before you can migrate from InfoSphere MDM Server for PIM V6.0.0 to InfoSphereMDM Collaboration Server V10.0.0, Fix Pack 1, you must ensure that you arespecifically using Fix Pack 12 for V6.0.0. If you are using V6.0.0 with any level offix pack from 1 through 11, you must migrate to V6.0.0 Fix Pack 12 following theinstructions in the IBM InfoSphere Master Data Management Server for ProductInformation Management Version 6.0.0, Fix Pack 12 documentation.


http://publib.boulder.ibm.com/infocenter/pim/v6r0m0/topic/com.ibm.wpc.rel.doc/wpc_con_releasenotes_fp12.html

http://publib.boulder.ibm.com/infocenter/pim/v6r0m0/topic/com.ibm.wpc.rel.doc/wpc_con_releasenotes_fp12.html

You can configure the error log file location by modifying the _ERROR_LOGSvariable in the migrateFrom600FP.sh migration script. This variable is set to$TOP/logs/errfile.log by default.

About this task

This is the only way to migrate from InfoSphere MDM Server for PIM V6.0.0 andno other means, such as using the environment export and import tool, can beused for this migration.






4. Point the InfoSphere MDM Collaboration Server V10.0.0, Fix Pack 1 instance tothe V6.0.0, Fix Pack 12 database schema. To point the instance to the database,add the database parameters in the env_settings.ini file. For moreinformation, see Setting the common database parameters.


6. Migrate your data as mentioned in Migrating master data from internal formatto XML format. If the migration was not successful, you can run the migrationscript again. You may refer to the Results section of this topic for a samplemigration summary.

7. Run the test_db.sh script to verify the database schema, the connectivitybetween InfoSphere MDM Collaboration Server and databases, and to check forJDBC and native client connections. For more information, see test_db.sh script.

8. Start the InfoSphere MDM Collaboration Server V10.0.0, Fix Pack 1 instance.9. Follow the instructions in the corresponding release notes to migrate to later fix

packs.

Results



This message is displayed if the migration succeeded:


-----------------------------------------------------------Summary of the migration-----------------------------------------------------------Migration to InfoSphere Master Data Management CollaborationServer 10.0.0 successful.

This message is displayed if the migration failed:!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!Migration Failed : xxxx!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!Please see the log file for further details :/home/pimuser/mdmcs10/logs/errfile.log



Migrating from V9.0.0 to V10.0.0To migrate to IBM InfoSphere Master Data Management Collaboration ServerVersion 10.0.0, Fix Pack 1 from IBM InfoSphere Master Data Management Serverfor Product Information Management Version 9.0.0, you need to run theappropriate migration script.

Before you begin

Before you can migrate from InfoSphere MDM Server for PIM V9.0.0 to V10.0.0,you must ensure that you are specifically using Fix Pack 7 or later for V9.0.0. Ifyou are using V9.0.0 with any level of fix pack from 1 through 6, you must migrateto V9.0.0 Fix Pack 7 or later following the instructions in the IBM InfoSphereMaster Data Management Server for Product Information Management Version9.0.0, Fix Pack 7 or appropriate documentation.

You can configure the error log file location by modifying the _ERROR_LOGSvariable in the migrateFrom900.sh migration script. This variable is set to$TOP/logs/errfile.log by default.

About this task

This is the only way to migrate from InfoSphere MDM Server for PIM V9.0.0 toV10.0.0, and no other means, such as using the environment export and importtool, can be used for this migration.




http://publib.boulder.ibm.com/infocenter/pim/v9r0m0/topic/com.ibm.pim.rel.doc/pim_con_releasenotes_fp7.html






4. Point the InfoSphere MDM Collaboration Server V10.0.0, Fix Pack 1 instance tothe V9.0.0, Fix Pack 7 or later database schema. To point the instance to thedatabase, add the database parameters in the env_settings.ini file. For moreinformation, see Setting the common database parameters.





packs.

Results



This message is displayed if the migration succeeded:-----------------------------------------------------------Summary of the migration-----------------------------------------------------------Migration to InfoSphere MDM Collaboration Server 10.0.0 successful.

This message is displayed if the migration failed:!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!Migration Failed : xxxx!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!Please see the file for further details : /home/pimuser/mdmcs10/logs/errfile.log




Migrating from V9.1.0 to V10.0.0To migrate to IBM InfoSphere Master Data Management Collaboration ServerVersion 10.0.0, Fix Pack 1 from IBM InfoSphere Master Data Management Serverfor Product Information Management Version 9.1.0, you need to run theappropriate migration script.

Before you begin

Before you can migrate from InfoSphere MDM Server for PIM V9.1.0 to V10.0.0,you must ensure that you are specifically using Fix Pack 2 or later for V9.1.0. Ifyou are using any other fix pack for V9.1.0, you must migrate to V9.1.0 Fix Pack 2or later following the instructions in the IBM InfoSphere Master Data ManagementServer for Product Information Management Version 9.1.0, Fix Pack 2 orappropriate documentation.

You can configure the error log file location by modifying the _ERROR_LOGSvariable in the migrateFrom910.sh migration script. This variable is set to$TOP/logs/errfile.log by default.

About this task

This is the only way to migrate from InfoSphere MDM Server for PIM V9.1.0 toV10.0.0, and no other means, such as using the environment export and importtool, can be used for this migration.






4. Point the InfoSphere MDM Collaboration Server V10.0.0, Fix Pack 1 instance tothe V9.1.0, Fix Pack 2 or later database schema. To point the instance to thedatabase, add the database parameters in the env_settings.ini file. For moreinformation, see Setting the common database parameters.








packs.

Results



This message is displayed if the migration succeeded:-----------------------------------------------------------Summary of the migration-----------------------------------------------------------Migration to InfoSphere MDM Collaboration Server 10.0.0 successful.

This message is displayed if the migration failed:!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!Migration Failed : xxxx!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!Please see the file for further details : /home/pimuser/mdmcs10/logs/errfile.log



Migrating Global Data Synchronization from V1.3.x to InfoSphere MDMCollaboration Server V10.0

You can migrate to IBM InfoSphere Master Data Management Collaboration ServerV10.0 by using scripts that automate most of the steps of the migration process.For a successful migration, you must perform a few manual steps by using theInfoSphere MDM Collaboration Server user interface.


About this task

Ensure that you use the base maintenance release of V1.3.1-IF011 for both Demandand Supply side implementations prior to starting the GDS migration.

Note: For the discussion of this topic and its sub topics we will reference GDS1.3.x for GDS 1.3.1-IF011.

Procedure1. Export: Metadata (data model) and data is exported from GDS V1.3.x backend

WebSphere Product Center V5.2.1.4 environment using the OOTB exportscripts.a. Metadata: Metadata definitions are exported in the form of compressed files

that contain the following:1) Definition files: These XML files are the actual definitions of various

objects (metadata) that are exported.2) Control file: An XML file that controls the import and maintains

references of the content of the compressed file. The file is calledImportEnvControl.xml.

3) Data files: Files that contain information about items and categories in aComma Separated Value (CSV) format.

GDS-specific docstore content, that forms the metadata for GDS objects, isexported as files in the file system.

b. Data: Data in InfoSphere MDM Collaboration Server can be an item or acategory. Item and categories created in GDS are exported in CSV formatand saved in the file system. GDS Notifications and Transactions areexported in separate compressed files that align to the metadata compressedfile format.

2. Transform: The migration import script has a step that enables thetransformation of exported metadata compressed files.

Note: In the case where WebSphere Product Center V5.2.1.4 specific metadatais exported by using export tools not provided by GDS, you must transform thegenerated compressed files by using the migration scripts available inInfoSphere MDM Collaboration Server V10.0 by processing the compressed filethrough the transformation utility on InfoSphere MDM Collaboration ServerV10.0 instance, <MDMPIM_Install_Dir>/bin/migrateCompanyZip.sh, whichgenerates InfoSphere MDM Collaboration Server V10.0 compatible compressedfiles.

3. Import: The transformed metadata compressed files and exported data isimported into InfoSphere MDM Collaboration Server V10.0 environment byusing the included import scripts.

Preparing to migrate from GDS 1.3.xYou must perform these preparatory steps for a successful migration from GDS1.3.x to IBM InfoSphere Master Data Management Collaboration Server V10.0.x.

Cleaning up your GDS dataYou must clean up the source WebSphere Product Center V5.2.1.4 instance toremove any unnecessary or unused data elements, particularly in the docstore.Removing these elements helps to reduce the time and resource requirements ofthe migration process.


Before you begin

Before you clean your GDS data, you must:v Back up the existing database. If problems occur during the cleanup process,

you might need to roll back the database.v Ensure that the GDS V1.3.x instance is stable. If the instance is stable, all

messages in the inbound queue have been processed by GDS and any action orscheduled job for sending messages into outbound queues is complete.

v Ensure that GDS is not connected to IBM WebSphere MQ, and GDS listenerservices are not running. To prevent sending or receiving any messages, stop allqueue connections.

v Ensure that the GDS V1.3.x environment variables refer to the correctdirectories.– The $TOP environment variable refers to the GDS installation directory when

referred to from the GDS installation directory, and to the WebSphere ProductCenter installation directory when referred to from the WebSphere ProductCenter installation directory.

– The WPC_ INSTALL_DIR environment variable refers to the WebSphereProduct Center V5.2.1.4 installation directory.

v Consult your database administrator to ensure that space is available for objectssuch as table spaces, INDX, USERS, and BLOBs in the database.

v Consult your database administrator to ensure that sufficient space is allocatedto database transaction log files to accommodate huge transactions.

v Ensure that the gds.properties file in the <GDS1.3.x_Install_Dir>/etc/defaultdirectory is configured correctly. The file must contain valid values for thecompany_code, gds_app_type and ACTIVE_DATA_POOL_ID variables.

v Ensure that the common.properties file in the <GDS1.3.x_Install_Dir>/etc/default directory is configured correctly. The file must contain validvalues for the db_userName, db_password and db_url variables and for parametersthat relate to messaging.

v Ensure that the common.properties file in the <WPC5.2.1.4_Install_Dir>/etc/default directory is configured correctly. The file must contain validvalues for the db_userName, db_password and db_url variables and for parametersthat relate to messaging

Procedure1. Delete all unused files from the docstore. For example, delete old logs, feeds

and other generated files that are not required.2. Delete any job and associated schedule that you do not need.3. Move out all the items and categories checked out in the collaboration areas.

All collaboration areas should be empty.4. Delete all of the GDS workflows and the collaboration areas that relate to those

workflows.5. Delete all GDS actionable notifications that are created for items checked out in

GDS workflows by running SQL queries. You can run these SQL queries fromeither the WebSphere Product Center V5.2.1.4 DB Admin console, any databaseclient or login to a database server and execute these SQL queries. In all thesequeries, you must replace <company_name> with the actual company namethat is defined in the company_code parameter in the gds.properties file. Thisfile is available in the <GDS_Install_Dir>/etc/default directory.


Note: Replace <company_name> with the actual company name that is definedin the company_code parameter in the gds.properties file.a. Run these SQL queries to remove notifications related to items checked out

in GDS workflow steps.Demand side SQL queriesdelete from rcpwhere RCP_COMPANY_ID = (

select CMP_COMPANY_ID from cmpwhere CMP_COMPANY_NAME=’<company_name>’)

and RCP_NTF_ID in (select NTF_ID from ntfwhere NTF_ACTION_CAUSE in (’SUBSCRIPTION_DELETION_APPROVAL’,’SUBSCRIPTION_PENDING_APPROVAL’,’REVIEW_INCORRECT_INITIAL_LOAD_PUBLICATION’,’REVIEW_INCORRECT_ITEM_CHANGE_PUBLICATION’,’REVIEW_INCORRECT_ITEM_CORRECT_PUBLICATION’,’ITEM_DELETE_PUBLICATION_VALIDATION_FAILED’,’REVIEW_INCORRECT_NEW_ITEM_PUBLICATION’,’NEW_ITEM_CATEGORY_MAPPING_PENDING’))

delete from ntfwhere NTF_COMPANY_ID = (


and NTF_ACTION_CAUSE in (’SUBSCRIPTION_DELETION_APPROVAL’,

’SUBSCRIPTION_PENDING_APPROVAL’,’REVIEW_INCORRECT_INITIAL_LOAD_PUBLICATION’,’REVIEW_INCORRECT_ITEM_CHANGE_PUBLICATION’,’REVIEW_INCORRECT_ITEM_CORRECT_PUBLICATION’,’ITEM_DELETE_PUBLICATION_VALIDATION_FAILED’,’REVIEW_INCORRECT_NEW_ITEM_PUBLICATION’,’NEW_ITEM_CATEGORY_MAPPING_PENDING’)

Supply side SQL queriesdelete from rcpwhere RCP_COMPANY_ID = (


and RCP_NTF_ID in (select NTF_ID from ntfwhere NTF_ACTION_CAUSE in (’EDIT_ITEM_APPROVAL_PENDING’,’ITEM_GLOBAL_ENRICHMENT_PENDING’,’ITEM_LOCAL_ENRICHMENT_PENDING’,’MODIFY_GLOBAL_ITEM_APPROVAL_PENDING’,’MODIFY_ITEM_APPROVAL_PENDING’,’MODIFY_ITEM_LINK_APPROVAL_PENDING’,’MODIFY_TRADING_PARTNER_PENDING_APPROVAL’,’NEW_ITEM_APPROVAL_PENDING’,’NEW_ITEM_PENDING_PUBLICATIONS’,’NEW_TRADING_PARTNER_PENDING_APPROVAL’,’TRADING_PARTNER_DELETION_APPROVAL’))



and NTF_ACTION_CAUSE in (’EDIT_ITEM_APPROVAL_PENDING’,’ITEM_GLOBAL_ENRICHMENT_PENDING’,


’ITEM_LOCAL_ENRICHMENT_PENDING’,’MODIFY_GLOBAL_ITEM_APPROVAL_PENDING’,’MODIFY_ITEM_APPROVAL_PENDING’,’MODIFY_ITEM_LINK_APPROVAL_PENDING’,’MODIFY_TRADING_PARTNER_PENDING_APPROVAL’,’NEW_ITEM_APPROVAL_PENDING’,’NEW_ITEM_PENDING_PUBLICATIONS’,’NEW_TRADING_PARTNER_PENDING_APPROVAL’,’TRADING_PARTNER_DELETION_APPROVAL’)

)

b. Run these SQL queries to remove notification entries that are not created foruser viewing.delete from rcpwhere RCP_COMPANY_ID = (


and RCP_NTF_ID in (select NTF_ID from ntf where NTF_SOURCE_USER_ID = -1

delete from ntf where NTF_COMPANY_ID = (select CMP_COMPANY_ID from cmpwhere CMP_COMPANY_NAME=’<company_name>’)

and NTF_SOURCE_USER_ID = -1

c. Run these SQL queries to remove notification entries that do not have anyrecipients.delete from rcpwhere RCP_COMPANY_ID = (


and RCP_NTF_ID not in (select NTF_ID from ntf)



and NTF_ID not in (select RCP_NTF_ID from rcp)

where <company_name> needs to be replaced by the actual company nameas defined in the company_code parameter of <GDS_Install_Dir>/etc/default/gds.properties file.

Removing implementation scripts attached to hierarchies andcatalogsYou must manually detach any implementation scripts that are attached to ahierarchy or catalog before exporting data. You can attach the scripts again afterthe hierarchies and catalogs are exported successfully.

Including additional searchable attributesIf your implementation has attributes that need to be runtime searchable (indexed)in the target IBM InfoSphere Master Data Management Collaboration Server V9.1.xenvironment, then you must add the attributes to the Demand_Params.xml (forDemand side) or Supply_Params.xml (for Supply side) files. These files, thatcontains all the searchable attributes provided in GDS data model, is in the$TOP/GDSMigration directory.

About this task

The file pkAndDspIndexedAttrs.xml is generated in the $TOP/GDSMigration/envInfodirectory during the FirstSteps step of the export process. This file contains all


primary key and display attributes that are indexed by default. You need to addthese attributes manually to the Demand_Params.xml (for Demand side) orSupply_Params.xml (for Supply side) files in the $TOP/GDSMigration directory.

Procedure1. Open the Demand_Params.xml (for Demand side) or Supply_Params.xml (for

Supply side) file by using a text editor.2. Add spec and attribute tags as required. For example, to index the sku and

productDetails attributes of the Master_Spec specification add the followingelements to the Demand_Params.xml or Supply_Params.xml file.<Spec name="Master_Spec"><Attribute>sku</Attribute><Attribute>productDetails/productName</Attribute></Spec>

The resulting Demand_Params.xml or Supply_Params.xml file will look like this:<?xml version="1.0" encoding="UTF-8"?><IndexableAttributes>.........<Spec name=" Master_Spec "><Attribute>sku</Attribute><Attribute>productDetails/displayAttribute</Attribute></Spec>.........</IndexableAttributes>

3. Save the file.

Updating the gds.properties fileYou must update the gds.properties file before you export GDS transactions,notifications, items, and categories.

About this task

To export objects from GDS V1.3.x, you must provide values for the followingproperties:v txn_no_of_rows - Specifies the number of transaction records that must be

exported in each XML file.v ntf_no_of_rows - Specifies the number of notification records that must be

exported in each XML file.v item_no_of_rows - Specifies the number of items or categories that are exported

into a .csv file. You can change the value to a higher number depending on thehardware resources available.

.

Procedure1. In the $TOP/etc/default directory, open the gds.properties file in the edit

mode by using a text editor.2. Add the export properties and set appropriate values. For example, you can set

the properties to the following recommended values:v txn_no_of_rows=1000v ntf_no_of_rows=1000


v item_no_of_rows=50003. Save the file.

Stopping the GDS applicationBefore you export your GDS environment from a GDS V1.3.x instance, you muststop all running WebSphere Product Center and GDS services and the RMI registryby running scripts in the specified order .

Procedure1. Stop the scheduler in WebSphere Product Center manually by running the

stop_scheduler.sh script. This script is in the <WPC_Install_Dir>/bin/go/stopdirectory.Attention: Ensure that no critical jobs are pending and that the job queue isclear.

2. Stop the GDS message listener by running the following scripts, which are inthe <GDS_Install_Dir//bin directory in the given sequence:a. Run the gdsmsg.sh script with the stop parameter. This script is in the

<GDS_Install_Dir>/bin directory.$<GDS_Install_Dir>/bin/gdsmsg.sh stop

b. After a few minutes have elapsed, run the gdsmsg.sh script with the abortparameter. This script is in the <GDS_Install_Dir>/bin directory. Thewaiting will allow the GDS message listener to finish processing themessages that it has already picked up.$<GDS_Install_Dir>/bin/gdsmsg.sh abort

3. Stop the GDS instance by running the stop_appsvr.sh script. This script is inthe <GDS_Install_Dir>/bin/go/stop directory.

4. Stop the WebSphere Product Center instance by running the abort_local.shscript. This script is in the <WPC_Install_Dir>/bin/go directory. This scriptstops the RMI registry and all WebSphere Product Center services that arerunning on the server.

5. Kill any rogue Java or RMI registry process that keeps running even aftershutting down the instance. Occasionally, it might take several attempts to killall Java processes. You must continue killing all Java processes started byWebSphere Product Center or Global Data Synchronization until no unwantedprocess is running.

Backing up the databaseBecause the migration process updates the data model in the database, you mustback up the GDS database before you migrate from GDS V1.3.x environment to aGDS in IBM InfoSphere Master Data Management Collaboration Server V10.0.xenvironment. If you encounter migration issues, you can roll back to the previousversion of the GDS database.

About this task

For Oracle users, there is a 4K limit on writing serialized forms to BLOBs whenusing the Oracle 9i client JDBC driver (to any Oracle 9i or Oracle 10g server).While migrating to InfoSphere MDM Collaboration Server V9.1.x, install Oracle10gR2 client to get the necessary 10gR2 jar files. Installing the client is advisableover manually updating the .jar files in the ORACLE_HOME directory.


Exporting from WebSphere Product Center V5.2.1.4You need to use the scripts included with GDS to export the metadata and data.The export process is divided into parts to ensure that error handling and recoveryare manageable.

Before you begin

Before you can export your GDS environment, you must:v Run the analyze_schema.sh script to analyze and improve the database schema.

This script is in the $TOP/src/db/schema/util directory where $TOP is theWebSphere Product Center installation directory. Running this script improvesexport performance during an export, especially when the volumes of items andcategories are large.

v Ensure that there is enough disk space in the file system.v Ensure that only relevant processes are running. To improve performance, shut

down all GDS and WebSphere Product Center services.v Consider exporting only part of the docstore content, even after you clean up

the docstore. Instead of exporting the entire docstore, you can export documentsfrom relevant directories such as scripts and params. For example, the followingscript exports documents from the scripts directory:envObjList = new EnvObjectList ();envObjList.addObjectByNameToExport (“/scripts","DOC_STORE");sDocFilePath = "archives/docstoreExport.zip" +out.writeln (exportEnv (envObjList, sDocFilePath));

About this task

If the GDS system is in a consistent state, you can export each object separately orall the objects together using the export_type=all option. You do not need toexport objects in a particular order. However, exporting all objects together is notrecommended because it is difficult to identity and resolve errors and exceptionsthat occur during the process.

The following script exports all of the objects when run from GDS v1.3.x installdirectory used as $TOP in the script. The logs for these steps are available in the$TOP/GDSMigration/Logs directory.

$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh--company_code=<cmp_code> --export_type=all

However, it is recommended using a step-wise approach as detailed below tomake the debugging easier. The options provided for export are:

MigrateExport.sh --company_code=<code>--export_type=<firstSteps/0/1/2/3/4/5/6/7/8/9>

with the options defined as follows:

company_codeSpecify the company code.

In the following scripts <cmp_code> is the value for the company_codeproperty in the $TOP/etc/default/gds.properties file. The logs for thesesteps are available in the $TOP/GDSMigration/Logs directory.


export_typeSpecify the export option. The following list defines the export options.v firstSteps - Finds scripts associated with Hierarchies and Catalogs, fetches

attributes to be indexed, gets datamodel information and fetches countof catalogs and items.

v 0 - Prepare the Instance for Exportv 1 - Export Basic Meta Data [Lookups, Specs, Attribute Collection,

Company Settings, Hierarchy, Catalogs etc]v 2 - Export Security [ACG, Role, Users, Selections etc]v 3 - Export Other Meta Data [Jobs, Feeds, Reports etc]v 4 - Export GDS XML Messagesv 5 - Export GDS Messaging Objects

Note: This is needed only for Demand side.v 6 - Export Transactionsv 7 - Export Notificationsv 8 - Export Hierarchy Contentv 9 - Export Catalog Content

Procedure1. Run the MigrateExport.sh script with the export_type parameter set to

firstSteps This script is in the $TOP/src/db/schema/gds/migration/9.1.0_migration directory. The script finds scripts that are associated withhierarchies and catalogs, fetches attributes to be indexed, gets data modelinformation, and fetches the count of catalogs and items.$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh

--company_code=<cmp_code> --export_type=firstSteps

This step is a preparatory step to provide user with information about thecurrent system and some actions that are needed before starting the actualexport. The step performs the following tasks:v Creates the file $TOP/GDSMigration/envInfo/CtgAttribInfo.txt detailing

scripts attached to catalogs present in the system.v Creates the file $TOP/GDSMigration/envInfo/HierAttribInfo.txt detailing

scripts attached to hierarchies present in the system.v Creates the file $TOP/GDSMigration/envInfo/pkAndDspIndexedAttrs.xml that

contains primary and display attributes to be added manually in the$TOP/GDSMigration/Demand_Params.xml (for Demand side) or$TOP/GDSMigration/Supply_Params.xml (for Supply side) files. These fileslists the default searchable attributes that are needed to be indexed (toenable search on these attributes) in InfoSphere MDM Collaboration ServerV10.0.

v Creates file $TOP/GDSMigration/envInfo/metaDataInfoList.txt that containsa list of all data model objects present in current GDS 1.3.x system.

v Creates file $TOP/GDSMigration/envInfo/itemAndCategoryCount.txt thatcontains the count of all catalogs and items present in current GDS 1.3.xsystem.

2. Run the MigrateExport.sh script with the export_type parameter set to 0. Thescript prepares the instance for export.$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh

--company_code=<cmp_code> --export_type=0


This option is required because a few object types and their definitions are notsupported in InfoSphere MDM Collaboration Server V10.0. Exporting data inthe existing format would lead to failure in the import process. For example,It is possible to have a node of type STRING as a parent node of some othernode (GROUPING) in the GDS 1.3.x environment. This is not possible in theInfoSphere MDM Collaboration Server V10.0 environment. Hence this must becorrected before this metadata is exported.

3. Run the MigrateExport.sh script with the export_type parameter set to 1. Thescript exports basic metadata such as lookups, specs, attribute collections,company settings, hierarchies, and catalogs.$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh


The metadata exported in the remaining steps is dependent on these objects tobe imported correctly. The following objects are identified as basic metadata:v COMPANY_ATTRIBUTESv LOOKUP_TABLE_SPECv LOOKUP_TABLEv LOOKUP_TABLE_CONTENTv PRIMARY_SPECv SUB_SPECv DESTINATION_SPECv SECONDARY_SPECv SCRIPT_INPUT_SPECv FILE_SPECv ATTRIBUTE_COLSv HIERARCHYv CATALOGv MAPSv ACG

These objects are exported the COMPANYMETADATA.zip file and then downloadedunder the $TOP/GDSMigration/ExportedZip directory.

4. Run the MigrateExport.sh script with the export_type parameter set to 2. Thescript exports the security definitions such as CONTAINER_ACCESSPRV,MY_SETTINGS, ROLES, and USERS.$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh


The above objects are exported to the SECURITY.zip file and then downloadedunder the $TOP/GDSMigration/ExportedZip directory.

5. Run the MigrateExport.sh script with the export_type parameter set to 3. Thescript exports other metadata such as jobs, feeds, and reports.$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh


In this step the export script handles other metadata such as:v DATASOURCEv FEEDSv JOBSv DISTRIBUTION


v EXPORTSv REPORTSv HIERARCHY_VIEWv CATALOG_VIEWv DISTRIBUTION_GROUPv ALERTv QUEUEv SEARCH_TEMPLATESv UDLv HIERARCHY_MAPSThe above objects will be exported to OTHERMETADATA.zip file and thendownloaded under $TOP/GDSMigration/ExportedZip directory.

6. Run the MigrateExport.sh script with the export_type parameter set to 4. Thescript exports GDS XML messages.$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh


All the XML messages exchanged between a GDS system and the connecteddatapool are stored in the WebSphere Product Center v5.2.1.4 docstore. Thefollowing objects are identified as GDS XML messages and the indicated partsof the docstore need to be exported:v XML messages stored under docstore path /archive/messages/inbound/v XML messages stored under docstore path /archives/messages/outbound/

These XML messages are exported and then downloaded under$TOP/GDSMigration/messages/inbound and $TOP/GDSMigration/messages/outbound directories with control files uplInXMLMsg.xml and uplOutXMLMsg.xml.Both the control files are stored in the $TOP/GDSMigration/messages directory.

7. For Demand side only, run the MigrateExport.sh script with the export_typeparameter set to 5. The script exports GDS messaging objects.$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh


All the GDS messaging objects created in the process of XML messageexchange between GDS and the connected datapool are stored in theWebSphere Product Center v5.2.1.4 docstore and need to be exported.The following objects are identified as GDS Messaging Objects:v All the Objects stored in the docstore under /object/messaging/

These objects will be exported and then downloaded under the$TOP/GDSMigration/object/messaging directory along with a control fileuplMessObj.xml in the $TOP/GDSMigration/object.

8. Run the MigrateExport.sh script with the export_type parameter set to 6. Thescript exports transactions.$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh


Transactions are core GDS objects and are identified as TRANSACTIONS.These objects will be exported to the TRANSACTIONS.zip file and thendownloaded under the $TOP/GDSMigration/ExportedZip directory.

9. Run the MigrateExport.sh script with the export_type parameter set to 7. Thescript exports notifications.


$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh--company_code=<cmp_code> --export_type=7

Notifications are core GDS objects and are identified as NOTIFICATIONS.These objects will be exported to the NOTIFICATIONS.zip file and thendownloaded under the $TOP/GDSMigration/ExportedZip directory.

10. Run the MigrateExport.sh script with the export_type parameter set to 8. Thescript exports hierarchy content.$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh


This phase is segregated from the other company data objects because thecontent of hierarchies account for the majority of an export. If there arehierarchies with a considerable volume of data (categories), then this phasecan be further divided to the hierarchy level, where each export contains thecontent of one hierarchy. Another possibility is to group all of the hierarchiesthat have smaller volumes of data into a .zip file and export the largerhierarchies into their own individual zip files. In GDS implementation most ofthe hierarchy contents are huge and cannot be exported as is using theWebSphere Product Center export environment. Hence a customized exportutility is provided to export the hierarchy contents. TheHIERARCHY_CONTENT(Categories) objects are identified as hierarchycontents.These objects will be exported and then downloaded under the$TOP/GDSMigration/feed_files/hierarchies directory along with a control fileuplHieCSV.xml in the $TOP/GDSMigration/feed_files.

Note: Data file (.csv) will be generated only for those hierarchies which haveat least one category in it.

11. Run the MigrateExport.sh script with the export_type parameter set to 9. Thescript exports catalog content.$TOP/src/db/schema/gds/migration/9.1.0_migration/MigrateExport.sh


In this step GDS catalog content is exported. This phase is segregated from theother company data objects because the content of catalogs account for themajority of an export. If there are catalogs with a considerable volume of data(items), then this phase can be further divided to the catalog level, where eachexport contains the content of one catalog. Another possibility is to group allof the catalogs that have smaller volumes of data into a .zip file and exportthe larger catalogs into their own individual zip files. In GDS implementationmost of the catalog contents are huge and cannot be exported as is using theWebSphere Product Center export environment. Hence a customized exportutility is provided to export the catalog contents. The CATALOG_CONTENTobjects are identified as catalog contents.These objects will be exported and then downloaded under the$TOP/GDSMigration/feed_files/catalogs directory along with a control fileuplCtgCSV.xml in the $TOP/GDSMigration/feed_files.

Note: Data file (.csv) will be generated only for those catalogs which have atleast one item in it.The number of items in a csv file depend on the parameter value set foritem_no_of_rows in the gds.properties file in GDS V1.3.x environment.


What to do next

Check the logs to get an insight on how the export completed. If a few objects didnot export successfully, you can complete the export again with only those objects.The compressed file that is created can be extracted and checked for missinginformation based on the error logs. Exports scripts can be run more than once.

Limitations of the export scriptAfter an export operation is complete, you must make sure that all the objects areexported and that all dependencies are satisfied. The export script does not verifythat all dependencies are exported and does not determine whether thecompressed file that is created can be imported successfully.

WebSphere Product Center level limitationsv Previous version exports: The migration tool does not export all versions of

metadata and data that are tagged in WebSphere Product Center. Only the latestversions of such objects are can be exported. Catalog rollback on imported datafrom the current export to a previous level is not supported because all tags oncatalogs and categories do not exist. You cannot export version differencesbecause only the latest version is available in the target system. For example, ifWebSphere Product Center has multiple versions of a catalog object, only thelatest version of the catalog is exported.

v Default objects exports: The migration tool does not export objects that arecreated by default when a new company is created. If your currentimplementation has altered objects, such as Default Hierarchy Primary Spec,Lookup Table Import Spec, and Default Lookup Table Hierarchy, then thechanges will not be carried forward because the tool expects to find them in thetarget company. Before you import these objects, you must, you must modify theobjects manually in IBM InfoSphere Master Data Management CollaborationServer V9.1.x to reflect the structures they have in WebSphere Product CenterV5.2.1.4.

v Organization hierarchies: In WebSphere Product Center V5.2.1.4, you cannot usethe migration tool to export organization hierarchies. You need to create suchhierarchies manually in the target company.

v Item/category ordering: The export of item/category ordering is not supported.v Role to locale mapping: The export of role to locale mapping is not supported.v Attribute Value Size: Attributes that have an integer value more than the integer

MAX_VALUE are not imported.v Users without any role: Users that have not been associated with a WebSphere

Product Center role are not exported.v Advance selection query language: The advance selection query language (rule)

is changed in InfoSphere MDM Collaboration Server v9.1.x. You must manuallymigrate all queries that were created before WebSphere Product Center V5.3.0.In InfoSphere MDM Collaboration Server V9.1.x, advanced selections are notmigrated automatically. You need to rewrite the rules in InfoSphere MDMCollaboration Server V9.1.x. You can use the following script operations to createselections in InfoSphere MDM Collaboration Server v9.1.x:– new DynamicSelection(String name, String WQL)– DynamicSelection::saveSelection()

Because WebSphere Product Center v5.3.2 does not allow a saveSelectionoperation if the WebSphere Query Language (WQL) is not valid, you must runthis script with the corrected and valid WQL. You can migrate dynamic selectionby completing the following steps:


1. Export all selections from WebSphere Product Center v5.2.1 and later fixpacks in the form of .csv files where the first value will be the name andsecond will be the rule string.

2. Convert the rules into valid WQL. For more information about WQL, seeQuery language.

3. Import rules and selections using script operations. The .csv files can beuploaded to the docstore or the values can be directly read from the scriptinput pane in the sandbox.

Here is a sample script for easy reference.Script input paneselection1, select item from catalog(’cata’)where item[’spec1/primary key’] = ’11’selection2, select item from catalog(’cata’)where item[’spec1/primary key’] = ’11’selection3, select item from catalog(’cata’)where item[’spec1/primary key’] = ’11’

Script panevar parser = newCSVParser(in);var bDone = false;var e = "";catchError(e){

while(!bDone){

attrs = parser.splitLine();if(attrs!= null){a = new DynamicSelection(attrs[0], attrs[1]);a.saveSelection();out.writeln(attrs[0] + " created");

}bDone = (null == attrs);

}}out.writeln(e);

v Relationship information: Hierarchy contents for hierarchies that have categorieswith data that is specified for relationship attributes do not import successfully.To work around this problem, complete the following steps:– Extract the compressed file generated from the company export.– Browse to the HIERARCHY_CONTENTS directory.– Edit each .csv file and delete the column or columns that specify relationship

data. Remember to save the files after editing.– Create a new compressed file and add the updated files to it. The directory

structure of the zip file must be the same as the compressed file that youextracted. The ImportEnvControl.xml file and the archives directory must beat the root level.

– Import the new. zip file instead of the exported zip.v Migration of property files: You need to migrate all WebSphere Product Center

property files manually. For more information about each property file, see theInfoSphere MDM Collaboration Server V9.1.x product documentation.

v Migration of the ctg_files directory: You need to manually copy the contents ofthe $TOP/public_html/suppliers/<cmp code>/ctg_files directory to the newinstance for each company


v Migration of user .jar files: You need to add the required user .jar files to thenew instance. See the InfoSphere MDM Collaboration Server V9.1.x informationcenter for information on adding the required user .jar files to a new instance

v Exporting and importing of inherited data: You cannot export and importinherited data. Catalog and hierarchy content that supports inheritance cannotbe exported or imported.

System Level Limitations

An export operation using the migration tool is not successful when a system levellimitation is reached. Common limitations include:v File system limitation: Many operating systems have file system limitations.

When using a particular file system you must decide how to split an exportbased on the size of metadata and data.

v Compressed file format limitation: The migration tool compresses the exportedfiles and then uploads them to the docstore. The compression utility might havean upper size limit for a single compressed file and the maximum number offiles per compressed file. To address this issue, split the exports logically so thatthe number of generated files is less than the upper limit.

v Compressed file generated using export operation appears empty: Thecompressed file generated using the export operation appears empty whenopened with Compressed (zipped) Folders utility on Windows XP. This is aknown issue. To avoid this problem, open the compressed file using the Winzipapplication.

Exporting the docstoreYou need to export the docstore separately.

Export the docstore separately because it stores a lot of content and exporting ittakes comparatively more time than any other object. You can export the entiredocstore or export parts of the docstore. Because the docstore is often too large forone compressed file, you might want to export the docstore in parts.

Partial/Selective docstore export

In this, the docstore is exported in parts. The following sample script demonstratesthe export of a docstore part named /object/messaging/://Sample script

var docStorePath = "GDSMigration/ExportedZip/";var sDocFilePath = docStorePath+"MESSAGINGOBJECTS.zip";var envObjList = new EnvObjectList();envObjList.setTypeToExport("DOC_STORE");envObjList.addObjectByNameToExport("/object/messaging/");//export the selected objects to the docstorevar result = exportEnv(envObjList, sDocFilePath);//check whether export was successfulif( result.contains("Uploaded the archived file to docstore") ) {out.println("result " + result);

}else {//if the export fails, the text of the result//will appear as an error message

throwError(result);}

This sample script exports the /object/messaging/ section of the docstore andsaves it in the docstore as /GDSMigration/ExportedZip/MESSAGINGOBJECTS.zip.


Complete docstore export

In this approach, the entire docstore is exported. Export the entire docstore onlywhen the docstore content fits in a single compressed file. The following samplescript exports the entire docstore://Sample script

var docStorePath = "GDSMigration/ExportedZip/";var sDocFilePath = docStorePath+"COMPANYDOCSTORE.zip";var envObjList = new EnvObjectList();envObjList.addAllObjectsToExport("DOC_STORE");

//export all the objects to the docstoreout.println("Saving environment as " + sDocFilePath);var result = exportEnv(envObjList, sDocFilePath);//check whether export was successfulif( result.contains("Uploaded the archived file to docstore") ) {out.println("result " + result);

}else {//if the export fails, the text of the result will//appear as an error messagethrowError(result);

}

This script exports the entire docstore and stores the compressed file that isgenerated in the docstore as /GDSMigration/ExportedZip/COMPANYDOCSTORE.zip.

Note: The sample script is not included in the MigrateExport.sh script. The objectDOC_STORE is also referred to as docstore.

Importing to InfoSphere MDM Collaboration Server V10.0Use the MigrateImport.sh script for importing GDS objects in the IBM InfoSphereMaster Data Management Collaboration Server V10.0 environment.

Before you begin

Before you can import your GDS environment, you must:v Ensure that all configurations and setup needed for GDS in InfoSphere MDM

Collaboration Server V10.0 are complete. You can refer to the configurations forGDS properties in a working GDS 1.3.x instance. Refer to Configuring GDSfeature for more information.

v Ensure that scripts to create schema, create_schema.sh and create a company,create_cmp.sh ran successfully. Both scripts are in the $<install dir>/bin/dbdirectory.

v Copy the GDSMigration directory and all its contents present in the GDS v1.3.xinstallation directory to the InfoSphere MDM Collaboration Server V10.0installation directory.

About this task

You must follow the phased approach and perform the steps in the import processin a specific order to import data successfully to InfoSphere MDM CollaborationServer V10.0. Each step requires you to run the import script with the import_typeparameter set to a different value. Because objects that you import in some stepsdepend on objects that you import in previous steps, ensure that each stepcompletes successfully before you begin the next step. Following the specifiedorder helps avoid failures due to object dependencies.


Best practices: There is no way to know which items failed during import, as thedebug report generated by the tool does not log such granular details. Scripts thatdrive the import of content like items and categories are:v /scripts/import/ctg/environment_catalog_content_import.scriptv /scripts/import/ctr/environment_category_tree_content_import.script

You can change these scripts to enable logging of failed items and categories.

In InfoSphere MDM Collaboration Server V10.0 the propertydebug_profile_db_connections in the common.properties file and the associatedcode which creates the LiteDBManager as the db manager, has been removed.Thus, the ThinPoolDBManager is the only db manager for InfoSphere MDMCollaboration Server V10.0.

The following script imports objects when run from the InfoSphere MDMCollaboration Server V10.0 installation directory used as $TOP in the script. Thelogs for these steps are in the $TOP/GDSMigration/Logs directory.

$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh--company_code=<cmp_code> --import_type=<gdsprev/0/1/2/3/4/5/6/7/8/9/10>

with the options defined as follows:

company_codeSpecify the company code.

In the following scripts <cmp_code> is the value for the company_codeproperty in the $TOP/etc/default/gds.properties file.

import_typeSpecify the import option. The following list defines the import options.v gdsprev - Loads GDS privilegesv 0 - Transform the exported compressed files.v 1 - Import metadata such as lookups, specs, attribute collections,

company settings, hierarchies, and catalogs.v 2 - Import hierarchy content categories.v 3 - Import security objects such as roles, users, and selections.v 4 - Create GDS workflows and load scripts.v 5 - Import other metadata such as jobs, feeds, and reports.v 6 - Import GDS XML messagesv 7 - Import GDS messaging objects

Note: This is needed only for Demand side.v 8 - Import Catalog content itemsv 9 - Import GDS transactionsv 10 - Import GDS notifications

Procedure1. Run the MigrateImport.sh script with the import_type parameter set to

gdsprev This script is available in the $TOP/src/db/schema/gds/migration/v9directory. The script loads GDS privileges.$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh

--company_code=<cmp_code> --import_type=gdsprev


In this step, the script loads GDS privileges in the InfoSphere MDMCollaboration Server V10.0 environment. Because there is no GDS data modelloaded by default, it is mandatory to load the privileges first.

Note: This step is a mandatory step.2. Run the MigrateImport.sh script with the import_type parameter set to 0. The

script transforms the exported compressed files.$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh

--company_code=<cmp_code> --import_type=0

This step is to transform the exported compressed files from GDS v1.3.xinstance into InfoSphere MDM Collaboration Server V10.0 format. The scriptreads all the exported zip files placed under $TOP/GDSMigration/ExportedZipdirectory, transforms them and places the transformed compressed files in the$TOP/GDSMigration/TransformedZip directory.

Note: You will see a SAXParseException when you transform theCOMPANYMETADATA.zip file because the MAPS.xml file is not an XML file eventhough it has a .xml extension. You can safely ignore this exception.

3. Run the MigrateImport.sh script with the import_type parameter set to 1. Thescript imports metadata including lookups, specs, attribute collections,company settings, hierarchies, and catalogs.$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh


This step is the first step of the actual import of the exported metadata anddata. You must import the compressed file of basic metadata first becausesubsequent imports are dependent on the metadata.The script imports the contents of the transformed COMPANYMETADATA.zip filepresent in the $TOP/GDSMigration/TransformedZip directory.

4. Run the MigrateImport.sh script with the import_type parameter set to 2. Thescript imports hierarchies and content categories.$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh


In this step the hierarchy contents are imported after the company or basicmetadata is successfully imported to the InfoSphere MDM CollaborationServer V10.0 instance. This step loads all the hierarchy content (in .csv files) aswell as the import scripts to the docstore and creates hierarchy import jobsthat need to be started manually after successful completion of this script.After successfully executing the script, start the import job manually. Refer tothe following task to import the hierarchy contents to the InfoSphere MDMCollaboration Server V10.0 instance; Immediately running the import jobs forhierarchy content.

5. Run the MigrateImport.sh script with the import_type parameter set to 3. Thescript imports security components such as ACG, role, users, and selections.$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh


Security components include ACGs, roles, users, selections, container accessprivileges, and My Settings. The script imports the contents of transformedthe SECURITY.zip file present in $TOP/GDSMigration/TransformedZip directory.

6. Run the MigrateImport.sh script with the import_type parameter set to 4. Thescript creates GDS workflows and loads scripts.


$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh--company_code=<cmp_code> --import_type=4

The GDS-specific scripts, workflows, and collaboration areas are not exportedfrom the GDS v1.3.x environment, but are created or loaded in this migrationstep.

7. Run the MigrateImport.sh script with the import_type parameter set to 5. Thescript imports other metadata such as jobs, feeds, and reports.$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh


The script imports all the remaining metadata that depends on the objectsimported in the previous steps. The import script imports the contents of thetransformed OTHERMETADATA.zip file present under the $TOP/GDSMigration/TransformedZip directory.

8. Run the MigrateImport.sh script with the import_type parameter set to 6. Thescript imports GDS XML messages to the docstore of the InfoSphere MDMCollaboration Server V10.0 target instance.$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh


9. For Demand side only, run the MigrateImport.sh script with the import_typeparameter set to 7. The script imports GDS messaging objects to the docstoreof the target InfoSphere MDM Collaboration Server V10.0 instance.$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh


10. Run the MigrateImport.sh script with the import_type parameter set to 8. Thescript imports catalog content items. For more information, refer toImmediately running the import jobs for hierarchy and catalog content .$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh


Import catalog contents after all the objects other than Transactions andNotifications and some parts of docstore are successfully imported to theInfoSphere MDM Collaboration Server V10.0 instance.The script loads all the catalog content (in .csv files) and the catalog importscripts to the docstore and creates catalog import jobs. The number of items ina csv file depend on the parameter value set for item_no_of_rows parameter inthe gds.properties file in the exported GDS 1.3.x environment. For example,each catalog content .csv file contains 1000 items. For every subsequent 1000items, a separate .csv file is created.The name format of the .csv files is: <Catalog_Name>[1,2,3..].csv. For example,if Global_Catalog contains 2000 items then for this catalog there will be two.csv files for item data. These files will be named Global_Catalog1.csv andGlobal_Catalog2.csv.

Note: You can import TradeCatalog contents only after you have successfullyimported the contents of Global_Catalog and Global_Local_Catalog.

11. Run the MigrateImport.sh script with the import_type parameter set to 9. Thescript imports GDS transactions.$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh


GDS transactions depend on users, items, and categories. Import transactionsonly after all these objects have been successfully imported.


The script imports the contents of the transformed TRANSACTIONS.zip filepresent under $TOP/GDSMigration/TransformedZip directory.

12. Run the MigrateImport.sh script with the import_type parameter set to 10.The script imports GDS notifications.$TOP/src/db/schema/gds/migration/v9/MigrateImport.sh


GDS Notifications depend on the users, items, categories and transactions. Youshould import notifications only after all these objects have been successfullyimported. The script imports the contents of transformed NOTIFICATIONS.zipfile present under $TOP/GDSMigration/TransformedZip directory.

Results

After your import completes successfully, you will see a difference in terms ofitem, transactions, and notification counts between GDS 1.3.1 and GDS in IBMInfoSphere Master Data Management Collaboration Server V10.0 environments.The difference is because of the dependencies that these have on each other duringthe import process.

For example, if an item was deleted from the GDS 1.3.1.x environment, itstransactions and notifications will not be deleted. During an export, such an itemwill not be fetched and therefore, an import can not create such an environmenteither. When transactions and notifications are being imported, the import processchecks for the existence of such items on which these transactions and notificationsare logged. If the item is not present these transactions and notifications are notimported as these would lead to exceptions in user interface if you were to click ona notification that does not have a related item to work with. Therefore, thedifference between the two environments exists.

What to do nextv You must check the reports generated by an import operation to make sure that

it terminated successfully.v You can also check InfoSphere MDM Collaboration Server logs for any errors

and exceptions.v You must perform the following steps before starting InfoSphere MDM

Collaboration Server V10.0 services on the imported data:1. Add entries for lookup tables created by the implementation team in GDS

V1.3.x in the GDSCacheRegistry.xml file in the InfoSphere MDMCollaboration Server V10.0 instance. This file is available in the$TOP/etc/default directory.

2. Update this list in the GDSCacheRegistry.xml file in the $TOP/etc/defaultdirectory:– Volume Unit of Measure– Weight Unit of Measure– Linear Unit of Measure– Language_LookUp

Immediately running the import jobs for hierarchy and catalogcontentYou need to import the hierarchy contents after the company or basic metadata issuccessfully imported to the IBM InfoSphere Master Data ManagementCollaboration Server V9.1.x instance. You need to start the import jobs manually


after successfully executing the import script to import the catalog contents to theIBM InfoSphere Master Data Management Collaboration Server V9.1.x instance.

Before you begin

You might see some extra jobs created that have CURRENT_DATE string in thedescription field. Delete these jobs without running.

About this task

After you run the MigrateImport.sh import script with the import_type parameterset to:v 2 for hierarchyv 8 for catalog

You need to start the hierarchy and catalog import jobs manually.

Procedure1. Delete the $TOP/logs directory.2. Imports are time consuming processes, therefore, a user session can time out.

Ensure the correct values are set for the max_inactive_interval property inthe $TOP/etc/default/common.properties file. See max_inactive_interval topicfor more information.

3. Start the InfoSphere MDM Collaboration Server appserver and schedulerservices only. Refer to Starting a service about how to start these services.

4. Log in to InfoSphere MDM Collaboration Server V9.1.x as Admin.5. Go to Data Model Manager->Scheduler->Jobs Console.6. Click Add for the job whose description contains either the hierarchy or

catalog name that you want to import, for example, HierarchyName.csv.7. Select Schedule as Run Immediately.

Note: If the application and database servers have different date or time, youcan start the job by using the One time run option and back dating the job.

8. Click Submit with default value None Given. You see the job status in the jobconsole screen.

9. Click the Action icon to see the completion status.10. Check for the errors and failures after the job is complete. You must give the

job adequate time to complete.11. Ensure that the scheduler and appserver logs under the $TOP directory do not

contain any failures or exceptions.12. Repeat steps 5 through 11 for the remaining hierarchies and catalogs that you

need to import.13. Delete the data source feed files (in .csv format) as well as the import job that

completed successfully, from the cleanup perspective.14. Stop InfoSphere MDM Collaboration Server services and proceed to next

import step.

Limitations of the import scriptUse these guidelines to work around the limitations of the import script.v Ensure that the compressed file is compatible with IBM InfoSphere Master Data

Management Collaboration Server V9.1.x. The import script will not be able to


import the compressed file successfully if it is not compatible with IBMInfoSphere Master Data Management Collaboration Server V9.1.x.

v Ensure that import operations are not stopped by users or system-level failures.If an import operation is stopped, then the state of the application is unknownand the database might be corrupted.

v Ensure that the compressed file contains all dependent objects. If the compressedfile does not contain all dependent objects, then you must create them manuallyin the application or by using compressed files that you imported previously.

You can check the debug report for information about import failures. However,the debug report might not record the exact reason for a failure. For moreinformation about import failures, see the InfoSphere MDM Collaboration Serverlogs.

Changes to the scripts in the GDS V1.3.x instance are lost in migration. You mustmanually migrate the changes to InfoSphere MDM Collaboration Server V9.1.x.

Collaboration Server objects not handled by GDS migrationFew Collaboration Server objects that are mostly customizations are not handledby GDS migration.

For example, reports is a Collaboration Server object that is not handled by GDSmigration.

Reports that are attached to implementation scripts would need changes to workin IBM InfoSphere Master Data Management Collaboration Server version 10.While running the migration step for import_type=5, errors related to such reportsare thrown onto the console. These errors are related to job types wherein CTGTODBis used for imports and REPORTEXE is used for reports. During an import, thesereports do get created but not the jobs that are attached to these reports. Therefore,in order to schedule these reports, jobs need to be created manually in InfoSphereMDM Collaboration Server version 10. Other objects not handled are Web services,advanced selections, implementation scripts and docstore content with respect toCollaboration Server implementation.

Verifying your migrated GDS environmentYou need to verify your migrated GDS environment after a successful migrationoperation.

There are three methods to quickly test the consistency of imports:v Compare item, catalog, and spec counts through the database. For example,

executing some queries against the CTG, CTR, and SPC tables can help ascertainthe number of specs and catalogs imported.

v For more comprehensive testing, export again from InfoSphere MDMCollaboration Server V9.1.x and perform a diff with the XSL transformed .zip filefrom WebSphere Product Center V5.2.1.4.

v Ensure that the business scenarios are tested end-to-end. If workflows are used,check out items and ensure that these work as expected in all steps in theworkflow and exit gracefully to see any potential issues with respect to scriptsor item attributes.

Compiling and debugging scriptsYou can use these simple methods to compile and debug scripts.


v To use compiled scripts, ensure that the common.properties file contains the thissetting:script_execution_mode=compiled_only

v For individual scripts, disable script compilation by including the this directiveat the beginning of the script:script_execution_mode=not_compiledHowever, this is not recommended as it leads to significant performancedegradation. If you use non-compiled scripts, you can set this parameter tonot_compiled rather than disabling compilation at the script level.

Note: If the server setting in common.properties file is set to not_compiled, thenthe script compilation for individual scripts cannot be enabled using script leveldirectives.

Using a combination of compiled and non-compiled scripts is not recommendedbecause the performance is adversely impacted. However, if you must use thiscombination, then please be aware that while a non-compiled scripts can invokefunctions in other compiled scripts, the reverse is not possible.

Common Script Compilation Errors

When using compiled scripts, a script can be saved in the script console only if itcompiles correctly. If there is an error, check the svc.out file in the appsvr logsdirectory for the full Java compiler (javac) output and error messages. Thefollowing are some common compilation errors:v A break or return statement inside a forEach*Element() block does not compile

due to an "unreachable code" error. To fix this issue:forEachItemSetElement(itemSet, item){

return item;}

Change it to:

forEachItemSetElement(itemSet, item){if (item != null) {

return item;}

}

This is equivalent, but satisfies the compiler.v If you return a value from a function, you must return a value in every case.

This sample code will not compile.function sample() {var e = null;catchError (e) {// do something...return "a string";} if (e != null) {reportError(...);}}

You must modify the function because it does not return a value if an exceptionoccurs in the catchError block.


Resolving runtime errors

To resolve runtime errors on the appserver, refer to the file svc.out in the appsvrlog directory. Sometimes, examining exception.log and default.log may behelpful. With the new generated .java file naming convention, it is easy to identifywhich script failed. The error message also identifies the line number in thegenerated .java file. To resolve a problem, view the generated .java file and scrollto the line where the runtime error occurred. The generated Java code nowincludes actual script code as comments every few lines. For example, consider thefollowing portion of code from a sample generated .java file:// function checkIfPartyPartyTypeExist(party, partyType)public static Object ScriptFunction__checkIfPartyPartyTypeExist(HashMap hmContext, Object party, ObjectpartyType) throws Exception{// var bRet = false;Object bRet = (java.lang.Boolean) Boolean.FALSE; //var rootEntry = party.getRootEntryNode();Object rootEntry = GenGetRootEntryNodeOperation.execute(hmContext ,

(IEntry) party);// var entryNodes = rootEntry.getEntryNodes(getCatalogSpecName() +"/Party Types/Party Type Code");Object entryNodes = GenGetEntryNodesOperation.execute(hmContext ,(EntryNode) rootEntry, (String)BinaryOperation.execute(BinaryOperation.PLUS,ScriptFunction__getCatalogSpecName(hmContext), "/PartyTypes/Party Type Code"));// var entryNodesSize = entryNodes.size();Object entryNodesSize = (java.lang.Integer)GenSizeOperation.execute(hmContext , (HashMap) entryNodes);


Chapter 5. Migrating InfoSphere MDM Collaboration Serverscripts

You can use scripts to perform several functions when using IBM InfoSphereMaster Data Management Collaboration Server. Scripts provide a high degree offlexibility without compromising on efficiency of operation or ease of development.

Script differences in various versionsThe base version used for IBM InfoSphere Master Data Management CollaborationServer Version 10.0.0 is WebSphere Product Center Version 5.0.1; therefore there arefunctional and behavioral differences between V5.2.1 and V10.0.0.

Attributes of data type Flag return different values in V10.0.0. In V5.2.1 the Flagdata type returned a string TRUE/FALSE. In 10.0.0 the Flag data type returns anequivalent of a Java Boolean value, which can have the values true/false/null.Therefore, when making a comparison using a flag attribute the comparisonshould be as follows:if (flagValue==null)

Also note that if the value of a Flag is printed, for example,out.write(flagValue);, the values printed will be either null, false, or true.

Because the code is compiled into Java when using compiled_only_mode, it willthrow an exception if IBM InfoSphere Master Data Management CollaborationServer scripts are using Java keywords as variables. Also it will fail to compile ifthe script contains variables that are already being used by InfoSphere MDMCollaboration Server in the generated code, for example, logger and hmContext.

Another key difference exists in the methods that return either an ItemSet or aCategorySet: In V5.2.1, if the method did not fetch any results, it returned null. InV5.3.2, and therefore in V10.0.0, these methods return an empty set:v Here are the methods which return an ItemSet:

– getCtgItemByAttributeValue(String sNodePath, String sValue)– getItemSetForCategory(Catalog ctg [, Boolean ordered])– getItemSetForCatalog()– getItemSetForUnassigned(CategoryTree ctr, boolean readOnly)– getItemSetForPrimaryKeys(Array pkeys, Boolean bOptimize)– getItemSetForSelection()– getSubset(IItemSet items, Integer start_point [, Integer end_point])

v Here are the methods which return a CategorySet:– getCategorySet([Boolean bReadonly])– getDescendentCategorySetForCategory([Boolean bReadonly])– getCategorySetByAttributeValue(String attribPath, Object attribValue, [Boolean

bReadOnly])– getCategorySetByPrimaryKey(String primaryKey, [Boolean bReadOnly])– getCategorySetByLevel(Integer level, [Boolean bReadOnly])– getCategorySetByFullNamePath(String[] fullNamePaths, String delimiter )


– getCategorySetByItemSecondarySpec(String specName)– getCategorySetByStandAloneSpec(String specName)– getLocationsAddedAvailability(CategoryTree locationHierarchy)– getLocationsChangedToHaveData(CategoryTree locationHierarchy)– getLocationsChangedToHaveNoData(CategoryTree locationHierarchy)– getLocationsHavingChangedData(CategoryTree locationHierarchy)– getAvailableLocations(Object locationOrCategoryTree)

Methods with different signatures in V5.2.1 and V10.0.0The following table compares the script operations added to the IBM InfoSphereMaster Data Management Collaboration Server V10.0.0 Scripting Library:

Table 5. A comparison of the methods with different signatures in V5.2.1 and V10.0.0

V5.2.1 operations V10.0.0 operations

checkString (String str, String defaultValue) checkString (String str, String defaultValue [,Boolean trim])

getEntriesInfoXMLInStep (StringstepName,ItemSet itemSet, HashMaphmAttrPaths[, int entriesCount])

getEntriesInfoXMLInStep (StringstepName,HashMap itemSet, HashMaphmAttrPaths[, int entriesCount,StringdateFormat])

userDefinedLogDeleteEntriesFor (IEntryentry)

userDefinedLogDeleteEntriesFor (Entryentry [, Entry category])

userDefinedLogAddEntry (Entry entry,[String log_message])

userDefinedLogAddEntry (Entry entry,[String log_message], [Entry category])

put (String sLkpTableName, StringsStartKey, [String sEndKey,] String[]asValues)

put (String sLkpTableName, StringsStartKey, String[] asValues)

createWebService (String name, String desc,String wsdlDocPath, String protocol, StringimplScriptPath, Boolean storeIncoming,Boolean storeOutgoing, Boolean deployed[,String style])

createWebService (String name, Stringimplclass, String desc, String wsdlDocPath,String wsddDocPath, String protocol, Stringstyle, String implScriptPath, BooleanstoreIncoming, Boolean storeOutgoing,Boolean deployed [, Boolean authRequired,Boolean skipRequestValidation, BooleanskipResponseValidation])

new$CtgItem ([String sCtgName/Catalogctg], [Boolean bRunEntryBuildScript],[Boolean bBuildNonPersisted])

new$CtgItem (String sCtgName/Catalogctg], [Boolean bRunEntryBuildScript],[Boolean bBuildNonPersisted], [BooleanbBuildEmptyEntryPicture])

printXML (String sTagName, String sValue,String sAttributes)

printXML (String sTagName, String sValue [,String sAttributes] [, boolean escape])

forEachXMLNode (String xPath [, XMLNodenode])

forEachXMLNode ([XMLNode rootNode],String xPath [, XMLNode node])

setHierarchyMapToExport (StringsourceHierarchy, String destHierarchy)

setHierarchyMapToExport (StringsourceHierarchy, String destHierarchy[,String sActionMode])

newUserDefinedLogEntry (Date date,Container container, Entry entry, String log)

newUserDefinedLogEntry (Date date,Container container, Entry entry, String log [,Entry category])

addObjectByNameToExport (StringsEntityName[, String sObjectType])

addObjectByNameToExport (StringsEntityName[, String sObjectType, [StringsActionMode]])


Table 5. A comparison of the methods with different signatures in V5.2.1 andV10.0.0 (continued)


userDefinedLogGetEntriesFor (IEntry entry) userDefinedLogGetEntriesFor (Entry entry[,Entry category])

buildSpec (String specName, StringspecType)

buildSpec (String specName, StringspecType, [Spec specFileType])

addAllObjectsToExport ([StringsObjectType])

addAllObjectsToExport ([String sObjectType,[String sActionMode]])

new Spec (String specName, StringspecType)

new Spec (String specName, StringspecType, [String specFileType])

getItemsInStepByAttribute (StringstepName,String searchAttributePath,StringsearchAttrValue,String sSortColumn[,booleanisAscending,int startIndex, int endIndex])

getItemsInStepByAttribute (StringstepName,String searchAttributePath,StringsearchAttrValue,String sSortColumn[,booleanisAscending,int startIndex, intendIndex,String categoryPKList])

setItemCategoryMapToExport (StringsCatalog, String sHierarchy)

setItemCategoryMapToExport (StringsCatalog, String sHierarchy [,StringsActionMode)

getItemXMLRepresentation (Spec spec,boolean includePrimaryKeyValue[, booleanaddNameSpace, String dateFormat])

getItemXMLRepresentation (Spec spec,boolean includePrimaryKeyValue[, StringdateFormat])

forEachUserDefinedLogEntry(UserDefinedLog UDL, String[] entries [,Boolean bReturnMultipleEntries = true])

forEachUserDefinedLogEntry(UserDefinedLog UDL, [Entry e,] String[]logEntries [, BooleanbReturnMultipleLogEntries = true])

setEntryAttrib (String sAttribPath, ObjectsValue, [Boolean bDoChecks])

setEntryAttrib (String sAttribPath, ObjectsValue)

invokeSoapServer (String sURL, StringsMethodName, Object[] aParamValues[,String[] aParamNames] )

invokeSoapServer (String sURL, StringsMethodName, Object[] aParamValues[,String[] aParamNames[, String userName,String password]] )

importEnv (String sDocFilePath) importEnv (String sDocFilePath,[bFromFileSystem])

getDocByPath(String sPath) getDocByPath(String sPath , BooleanforceSync)

jmsGetQueueConnection() jmsGetQueueConnection([String username],[String password])

sendEmail(String emailTos, StringemailSubject, String emailBody, [DocemailAttachment | Doc[]emailAttatchments])

sendEmail(String emailTos, StringemailSubject, String emailBody, [DocemailAttachment | Doc[] emailAttatchments,String ccList, String bccList])

sendHTMLEmail(String emailTos, StringemailSubject, String emailBody, [DocemailAttachment | Doc[]emailAttatchments])

sendHTMLEmail(String emailTos, StringemailSubject, String emailBody, [DocemailAttachment | Doc[] emailAttatchments,String ccList, String bccList])

addEntryIntoColArea(Entry entry, StringstepPath )

addEntryIntoColArea(Entry entry, StringstepPath, [boolean waitForStatus])

getColAreaByName(String colAreaName) getColAreaByName(StringcolAreaName,[boolean useCache])

Chapter 5. Migrating InfoSphere MDM Collaboration Server scripts 47

Methods with different signatures in V5.3.0 and V5.3.0.1The following table compares the methods with different signatures in WebSphereProduct Center V5.3.0 and V5.3.0.1.

Table 6. A comparison of the methods with different signatures in V5.3.0 and V5.3.0.1

V5.3.0 operations V5.3.0.1 operations

getSpecByName (String name) getSpecByName (String name, [BooleanbImmutable])

For information on methods with different signatures between WebSphere ProductCenter V5.3.0.1 and InfoSphere MDM Collaboration Server V10.0.0, refer to“Methods with different signatures in V5.3.0.1 and V10.0.0 and later.”

Methods with different signatures in V5.3.0.1 and V10.0.0 andlater

The following table compares the script operations added to the InfoSphere MDMCollaboration Server and later Scripting Library:

Methods with different signatures in WebSphere Product Center V5.3.0.1 andIBMInfoSphere MDM Collaboration Server V10.0.0 and later.

Table 7. A comparison of the methods with different signatures in V5.3.0.1 and V10.0.0

V5.3.0.1 operations V10.0.0 operations

jmsGetQueueConnection() jmsGetQueueConnection([String username],[String password])

createWebService(String name, Stringimplclass, String desc, String wsdlDocPath,String wsddDocPath, String protocol, Stringstyle, String implScriptPath, BooleanstoreIncoming, Boolean storeOutgoing,Boolean deployed [, Boolean authRequired])

createWebService (String name, Stringimplclass, String desc, String wsdlDocPath,String wsddDocPath, String protocol, Stringstyle, String implScriptPath, BooleanstoreIncoming, Boolean storeOutgoing,Boolean deployed [, Boolean authRequired,Boolean skipRequestValidation, BooleanskipResponseValidation])

getDocByPath(String sPath) getDocByPath(String sPath , BooleanforceSync)

sendEmail(String emailTos, StringemailSubject, String emailBody, [DocemailAttachment | Doc[]emailAttatchments])

sendEmail(String emailTos, StringemailSubject, String emailBody, [DocemailAttachment | Doc[] emailAttatchments,String ccList, String bccList])

sendHTMLEmail(String emailTos, StringemailSubject, String emailBody, [DocemailAttachment | Doc[]emailAttatchments])

sendHTMLEmail(String emailTos, StringemailSubject, String emailBody, [DocemailAttachment | Doc[] emailAttatchments,String ccList, String bccList])

addObjectByNameToExport (StringsEntityName[, String sObjectType])

addObjectByNameToExport (StringsEntityName[, String sObjectType, [StringsActionMode]])

addAllObjectsToExport ([StringsObjectType])

addAllObjectsToExport ([String sObjectType,[String sActionMode]])

setHierarchyMapToExport (StringsourceHierarchy, String destHierarchy)

setHierarchyMapToExport (StringsourceHierarchy, String destHierarchy[,String sActionMode])


Table 7. A comparison of the methods with different signatures in V5.3.0.1 andV10.0.0 (continued)

V5.3.0.1 operations V10.0.0 operations

setItemCategoryMapToExport (StringsCatalog, String sHierarchy)

setItemCategoryMapToExport (StringsCatalog, String sHierarchy [,StringsActionMode)

addEntryIntoColArea(Entry entry, StringstepPath )

addEntryIntoColArea(Entry entry, StringstepPath, [boolean waitForStatus])

getColAreaByName(String colAreaName) getColAreaByName(StringcolAreaName,[boolean useCache])

Methods with different signatures in V6.0.0 and V10.0.0 andlater

The following table compares the script operations added to the IBM InfoSphereMaster Data Management Collaboration Server V10.0.0 and later Scripting Library:

Methods with different signatures in IBM InfoSphere MDM Server for PIM V6.0.0.and InfoSphere MDM Collaboration Server V10.0.0 and later.

Table 8. A comparison of the methods with different signatures in V6.0.0 and V10.0.0


String exportEnv(EnvObjectList envObjList,String sDocFilePath)

String exportEnv(EnvObjectList envObjList,String sDocFilePath, [String sMapFilePath])

Methods only in V5.2.1This section lists the methods available only in WebSphere® Product Center V5.2.1.v populateFromPathValueMap (HashMap pathValueHashMap)v getItemNode (String sPath)v getCategoryPathsForInheritedValue (String sPathDelimiter, [Boolean bWithRoot])v setTabular (String str)v getRootItemNode ()v setInheritanceTargets (String[][] containers)v getItemNodes (String sPath)v setWflStepAttributeGroups (String[]/AttrGroup[] attrGroups)v getMappedAttributeGroups ()v dummy ()v deleteInheritanceRule ()v getInheritanceTargets ()v getItemNodePath ()v getCtgItemAttribs ()v getItemSetAndCountForSelection ()v getItemNodeValue ()v getEntryAttribModifier (String sAttribPath)v getChangedAttributes (Entry secondEntry)v massUpdate (Selection sel, String scriptPath, String parametersPath)v isEntryNodeInheritedDataFromItem ()


v getChangedAttributesForMultiOccurrence (Entry oldEntry)v new$AdvancedSelection (Catalog catalog, String name, String expression)v getInheritanceRuleByName (String sRuleName)v getCtgItemRelatedItemInfo (Integer iItemId)v disableInheritance ()v setItemSetFetchCategorySpecificAttributes (Boolean b)v setItemNode (String sPath)v debug (String s)v getEntryNodeInheritedValueSourceEntryUniqueID ()v getSelectionRule ()v getItemsInheritingDataForPath (String sAttribPath)v setItemNodeRelationshipValueUsingItem (Item relatedItem)v new$InheritanceRule (Container container, String ruleName)v getItemNodeChildren ()v getCtgItemAttributesStatus ()v getEntryNodeInheritedDataContainerName ()v addSubNode (Node node)v setItemNodeRelationshipValue (Catalog relatedItemCtg, String

sRelatedItemPrimaryKey)v reflattenAllInheritanceRules ()v getEntryAttribModificationTime (String sAttribPath)v removeAttributeGroup (String attributeGroupName)v saveRule ()v setItemNodeValue (Object value)v addAttributeGroup (String attributeGroupName)v setEntryAttributesFromXMLRepresentation (String xPath [,String dateFormat)v resetAttributeGroupsToProcess ()

Methods only in V5.3.0.1This topic lists the methods available only in WebSphere Product Center V5.3.0.1.v loadCatalog(String docStorePathForFileToLoad, Spec fileSpec, SpecMap specMap,

String feedType [itm|icm|ctr])v getEntryRelatedItemInfo(int iItemId)

Methods only in V9.0.0 carried forward to V10.0.0This topic lists the methods available only in IBM InfoSphere Master DataManagement Collaboration Server V9.0.0 carried forward to V10.0.0.v commitDB()v new LinkHandler(String wflName)v updateLinks(IEntrySet entrySet)v New PathSelectionHandler(ICollaborationArea colArea)v selectAndSetPath(IEntrySet entrySet,String propertyName)v MultiMoveHandler(String wflName)v moveEntries(IEntrySet entrySet,String stepPath)v loadWF(String filePath)v checkOutItem(String wfName, String itemID)


v checkOutCategory(String wfName, String categoryId,String categoryTreeName)v new ChildCheckinHandler(String wflName)v checkInChilds(IEntrySet entrySet, String stepPath)v TIAttrVerifier(String wflName)v verifyAttrGroupsAndSetExitValues(IEntrySet entrySet,String []

attrCollectionNames)v new GDSXMLDocument(Doc doc/String str)v getXMLNodeValue(Boolean bRequired)v setXMLNodeValue(String sPath, String value)v getGDSXMLNodeName()v getXMLNodePath()v getGDSXMLNode()v addXMLNode(GDSXMLNode xmlNode [,String path])v removeXMLNode(Object obj)v getXMLNode(String path)v cloneXMLNode()v setValue(String path, String value)v getGDSXMLNodes(String path)v removeAustinNodes(String path)v getXMLString()v getGDSXMLNodeFromXMLNode(XMLNode xmlnode)v getNewPublicationMessageIds()v getNewPublicationMessageIdsByType(String[] messageTypes)v getPublicationMessageIdsByDate(String fromDate, String toDate [,String

recipientGLN])v MessageItemHandler(String messageId)v getTradeItems()v sendConfirmation(String confirmationType,String[] messageIds)v getLinks()v changeState()v getHierarchyTree()v getAssociatedLinks(String gtin, Boolean fetchChildLinks)v getInternalCode()v setNodeType(String nodeType)v sendCICConfirmationReasonCodes(String confirmationType,String

MsgId,HashMap hmCICReasonCodeData)v new CICStatus(String confirmationStatusCode, String

confirmationStatusCodeDescription, String languageISOCode [,StringadditionalConfirmationStatusDescription] [,String correctiveAction] [,StringexpectedCorrectiveInformation])

v getParent(int index)v getChild(int index)v getNumberOfChildren()v getNumberOfParents()v getRootTradeItem()v isLeaf()


v getLinkQuantity()v createNotification(IBusinessObject iObj, String notfType, String userName)v new TradeItemSS(String sGtin, String sGTINName, String sProductType, String

sInternalCatCode, [String sDataPoolCatCode])v getTradeItemSS(String sGTIN,String sTM,String sIP)v setTradeItemAttributesSS(HashMap hmAttributePathsToValues)v setTradeItemAttributeSS(String attributePath,String attributeValue)v getTradeItemAttributeValueSS(String sAttrPath)v toBoolean(String str)v validateGTIN(String sGTIN)v validateGLN(String sGLN)v getGTINCategory(String sGTIN)v getGTINTree(String sGTIN, String sProductType, Integer iLinkQuantity, String

sLinkStatus)v addChild(GTINTree tree)v removeChild(String sGTIN)v saveTradeItemSS()v searchTradeItems(HashMap hmSearchParamsToValues)v getTradeItemParentLinks()v getTradeItemChildLinks()v getModifiedTradeItems(String transactionType, Date startDate, Date endDate)v getItems()v setUDEXCategoryCode(String code)v setInternalCategoryCode(String code)v validateTradeItem()v validateTradeItemAttribute(String sAttrPath)v validateTradeItemAttributeGroup(String sAttributeGroup)v new TradeItemDS(String sEANUCCCode, String sEANUCCCodeType, String

sExtensionName, String sProductType,String sGPCCode[,StringsInternalCatCode,String sGTIN ,String sGTINName])

v getExchangeSpecificAttribute()v getTradeItemDS(String sEANUCCCode,String sTM,String sIP,[String

sGTIN],[String recipientGLN])v setTradeItemAttributesDS(HashMap hmAttributePathsToValues)v setTradeItemAttributeDS(String attributePath,String attributeValue)v getTradeItemAttributeValueDS(String sAttrPath)v saveTradeItemDS()v getAllTradeItemAttributes()v searchTradeItemsDS(HashMap hmSearchParamsToValues)v deleteTMIPVariant()v deleteGTIN()v isTradeItemCheckedOut()v getWWREExchangeSpecificAttribute()v isWWREInteroperablee()v addItemSS(HashMap sEntryMap, String strDate)


v synchronizeItemChangesSS(HashMap sEntryMap, String strDate, StringoperationType)

v publishNewItemSS(HashMap sEntryMap, HashMap tradingPartners,StringstrDate, String operationType)

v sendInitialLoadSS(HashMap sEntryMap, HashMap tradingPartners, StringstrDate, String operationType)

v addItemLinksForMassTransactionsSS(HashMap sEntryMap, String strDate)v getCtgItemAttribValues()v readGDSPropertiesSS(String sPropkey)v searchTradeItems(HashMap hmSearchParamsToValues,String start, String end)v processMassTransaction(String massJobID,HashMap hmSearchParamsToValues)v HashMap setMassImportSS(boolean bImport)v publishPublicationList(HashMap hmSearchParamsToValues)v new TradeItemLink(String parentGTIN, String childGTIN [,Integer

linkQuantity])v setLinkAttributes(HashMap hmAttributeNamesToValues [,String

informationProvider])v setLinkAttribute(String attributeName,String attributeValue [,String

informationProvider])v getTradeItemLink(String parentGTIN, String childGTIN)v saveTradeItemLink()v deleteTradeItemLink()v getLinkAttributeValue(String sAttrName)v getParentGTIN()v getChildGTIN()v new TradingPartner(String sGLN, String sPartnerName, String sCountry, String

sGLNID, String itemType)v new TradingPartner(String sGLN, String sPartnerName, String sCountry, String

itemType)v getTradingPartner(String sGLN)v setPartnerAttributes(HashMap hmAttributePathsToValues)v setPartnerAttribute(String attributePath,String attributeValue)v saveTradingPartner()v searchTradingPartners(HashMap hmSearchParamsToValues)v getPartnerAttributeValue(String sAttrPath)v createTransaction(IBusinessObject iObj, String txnType, String userName)v isString()v iterator()v hasNext()v next()v isLangSpecificAttr(String sAttrPath)v getGDSLanguages()v flushGDSCache()v new WWREMessageHandler(String wflName)v sendMessage(IEntrySet entrySet,String messageType[, List transactionVOList])v new MessageValidationResult(String sMsgID, String sMessage)


v new TradeItemValidationResult(String sKey)v new AttributeValidationResult(String sKey)v new ValidationResultObject(String sRuleName)v addValidationResult(ValidationResultObject refValidationResultObject, String

sMessage, String sStatus, String sType, Object objHolder)v addValidationResultObject(AbstractValidationResult refAbstractValidationResult,

ValidationResultObject refValidationResultObject)v addTradeItemValidationResult(MessageValidationResult

refMessageValidationResult, TradeItemValidationResultrefTradeItemValidationResult)

v addAttributeValidationResult(TradeItemValidationResultrefTradeItemValidationResult,AttributeValidationResultrefAttributeValidationResult)

v getValidationResultObjectList(AbstractValidationResultrefAbstractValidationResult)

v getTradeItemValidationResultList(MessageValidationResult msgValidationResult)v getAttributeValidationResultList(TradeItemValidationResult

tradeItemValidationResult)v setValidationResultStatus(boolean bStatus)v getValidationResultStatus()v setValidationResultMessage(String message)v setLocalizedValidationResultMessage(String messageID [,String[] arguments])v addLocalizedValidationResultMessage(String messageID [,String[] arguments])v getValidationResultMessage()v setValidationResultHolder(Object holder)v getValidationResultHolder()v setValidationResultType(String sType)v getValidationResultType()v getTradeItemsInMsgItemDS(Item msgItem)v getValidationResult(AbstractValidationResult refAbstractValidationResult)v getMessageTypeName(Item msgItem)v getDataPoolNameForMsgItem(Item msgItem)v new TransactionHandlerDS()v insertTransactionDS(ICollaborationArea colArea,IEntrySet entrySet,String

stepPathString,String trasactionType,String status,String stepTrasition)v updateTransactionDS(ICollaborationArea colArea,IEntrySet entrySet,String

stepPathString,String trasactionType,String status,String stepTrasition)v new StatusUpdaterDS()v updateTradeItemGlobalStatusDS(IEntrySet entrySet,String status)v updateTradeItemLocalStatusDS(IEntrySet entrySet,String status)v updateStatusDS(IEntrySet entrySet,String status)v new NotificationHandlerDS(String wflName)v notifyUsersForActionDS(IEntrySet entrySet,String action)v notifyUsersForActionWithStatusDS(IEntrySet entrySet,String action)v new InternalSyncHandler()v synchronize(IEntrySet entrySet)v new EnrichmentHandler()


v canStartEnrichment(IEntrySet entrySet)v startEnrichment(IEntrySet entrySet)v new InitialLoadSaver()v saveInitLoadEntries(IEntrySet entrySet)v new MessageValidator()v checkInitLoadAndSetExitVal(IEntrySet entrySet)v new CategoryMappingValidator()v verifyAndSetExitValues(IEntrySet entrySet)v getTransactionDetails(ICollaborationArea colArea,IEntrySet entrySet,String

stepPathString,String trasactionType,String status,String stepTrasition)v runWFTest(String ar1,String arg2, String arg3)v createTestData(String ar1,String arg2)v GDSCreateMassPublicationItems(IEntrySet entrySet)v GDSDeleteMassPublicationItems(IEntrySet entrySet)v GDSCheckFilters(IEntrySet entrySet)v LogInboundTransaction(IItem msgItem,String transactionType, String

senderGLN, String msgFilePath)v TransactionHandlerSS()v insertTransactionSS(ICollaborationArea colArea,IEntrySet entrySet,String

stepPathString,String trasactionType,String status,String stepTrasition)v updateTransactionSS(ICollaborationArea colArea,IEntrySet entrySet,String

stepPathString,String trasactionType,String status,String stepTrasition)v new StatusUpdaterSS()v updateStatusSS(IEntrySet entrySet,String status)v updateTradeItemGlobalStatusSS(IEntrySet entrySet,String status)v updateTradeItemLocalStatusSS(IEntrySet entrySet,String status)v new NotificationHandlerSS(String wflName)v notifyUsersForActionSS(IEntrySet entrySet,String action)v notifyUsersForActionWithStatusSS(IEntrySet entrySet,String action,String status)v invokeWorkflowSS(HashMap entryMap, String sWFName)

Methods only in V5.3.2 carried forward to V10.0.0This section lists the methods only in WebSphere Product Center V5.3.2 carriedforward to IBM InfoSphere Master Data Management Collaboration Server V10.0.0.v publishEntriesToSrcContainer (EntrySet entrySet)v setLdapOperation (LdapOperation operation)v setViewableAttributeGroups (String subViewType, String[]/AttrGroup[]

attrGroups, [String locationHierarchyName])v isItemAvailableInLocation (Category location)v isBinary ()v reset ()v getCurrentLocation ()v getEntryInStep (String stepPath)v deleteLookupTable (LookupTable lkp)v assertFalse (Boolean condition, [String message])v getEntryAttribValues (String sAttribPath)


v getSearchTemplateName ()v getLdapObjectclasses ()v getCategoryParentsUsingCache (CategoryCache cat_cache)v getCtgItemLocationAttribsForKeys (Category location, Object[] aAttribPath [,

String sDelimiter])v getAddedAttributePathsNewEntry ([Category location])v getItemRootEntryNodesHavingLocationData ()v getEntryChangedDataSinceLastSave ()v getDate (int columnIndex)v addLdapAttribute (LdapAttribute attribute)v getLocationPathForInheritedValue (String delimiter)v getModifyLocationHierarchyAvailability (String locationHierarchyName)v makeItemAvailableInLocations (Category[] locations, [Boolean bRecursive])v encodeUsingCharset (String charset)v getLocationsAddedAvailability (CategoryTree locationHierarchy)v getEntryRelationshipAttrib (String sAttribPath)v new$LdapObjectclass (String objclass)v getWflStepView (String subViewType, [String locationHierarchyName])v getLocationsChangedToHaveData (CategoryTree locationHierarchy)v setLdapDistinguishedName (LdapAttribute dn)v getLocation ()v xmlDocToString ()v getAvailableLocations (Object locationOrCategoryTree)v writeFileUsingReader (Reader r)v setEditableAttributeGroups (String subViewType, String[]/AttrGroup[]

attrGroups, [String locationHierarchyName])v getDynamicSelectionQueryString ()v setActionModeToExport (String sActionMode)v addLdapEntry (LdapEntry entry)v getLdapOperation ()v getCategory (int columnIndex)v getHierarchy (int columnIndex)v removeLocationSpecificData (CategoryTree ctr)v parseDate (String value, String format[,Locale locale])v new$SearchQuery (String queryString)v getStepsForEntry (Entry entry)v getWsddDocPath ()v setRequiredAttributeGroups (String subViewType, String[]/AttrGroup[]

attrGroups, [String locationHierarchyName])v getWflStepViews ()v startExportByName (String sName)v getErrorsForLocation ()v getInt (int columnIndex)v parseXMLNodeWithNameSpace (String sXMLSubPath)v initializeKeyValueMapping (Object[] aKeyset)


v assertTrue (Boolean condition, [String message])v getCtgItemAttribsForKeys (Object[] aAttribs [, String sDelimiter])v getNodeDisplayName ([Locale locale])v getLocationErrors ()v getLdapEntries ()v getRequiredAttributeGroups ([String subViewType], [String

locationHierarchyName])v getEntryChangedData (Entry oldEntry, Entry newEntry)v getLocaleNode (Locale locale)v locationHasData (Category location)v execute ()v makeItemUnavailableInLocations (Category[] locations, [Boolean bRecursive])v getLdapAttributes ()v assertNotNull (Object obj, [String message])v getLocationsHavingChangedData (CategoryTree locationHierarchy)v getLocationsHavingData (Object locationOrCategoryTree)v getSpec (int columnIndex)v getItemLocationAttrib (Category location, String sAttribPath)v runQuery (String qryString)v getLdapAttributeValue ()v defineLocationSpecificData (CategoryTree ctr, Spec spc, AttrGroup[] inhAttrGrps)v new$SearchTemplate (String name, Array attrGroupNames, Container container,

String desc, [String colAreaName, String stepPath])v getBoolean (int columnIndex)v setItemLocationData (Item item, CategoryTree locationTree, String[] locFullPaths,

String delimiter, Boolean rootIncluded[, Boolean append])v setImplclass (String implclass)v isInheriting (Category location, String sAttribPath)v new$LdapEntry ()v getLdapAttributeType ()v setXMLNodeValue (String sPath, String value)v parseLDIFFile (String filename)v dropEntry (Entry entry)v new$DynamicSelection (String selectionName, String queryString)v makeItemAvailableInLocation (Category location, [Boolean bRecursive])v getCategoryChildrenUsingCache (CategoryCache cat_cache)v isDefined (int columnIndex)v getEntryNodeType ()v setAuthRequired (Boolean authRequired)v flushScriptCache ()v getLocationsRemovedAvailability (CategoryTree locationHierarchy)v getScriptExecutionMode ()v getModifiedAttributePathsOldEntry ([Category location])v copySearchItemData (Item searchItem[, Boolean append])v copySearchItemLocationTreeData (Item searchItem, CategoryTree locationTree[,

Boolean append])


v createLDIFFile (String docstore_filename, LdapEntrySet entrySet)v getLong (int columnIndex)v decodeUsingCharset (String charset)v moveEntryToNextStep (Entry entry, String stepPath, String exitValue)v isAuthRequired ()v getSearchTemplateByName (String name)v getItemRootEntryNodeForLocation (Category location)v getViewableAttributeGroups ([String subViewType], [String

locationHierarchyName])v moveEntryToColArea (Entry entry, String destColAreaName)v getCtgViewType ()v getPossibleEntryNodeValues ()v getItemUsingEntryRelationshipAttrib (String sAttribPath)v javaArrayFromScriptArray (Array scriptArray, String type)v getXMLNode (String nodePath)v assertEquals (Object expectedValue, Object actualValue, [String message])v addLdapObjectclass (LdapOperation objectClass)v new$LdapEntrySet ()v setNodeIndexed (Boolean)v isNodeIndexed ()v getProductCenterURL - Returns the property trigo_web_url defined in the

common.properties file, which holds the fully-qualified URL, including portnumber, of the web site where users should point their browsers to access thisinstance of InfoSphere MDM Collaboration Server.

v assertNull (Object obj, [String message])v setXMLNodeValues (String sPath, String[] values)v setModifyLocationHierarchyAvailability (String locationHierarchyName, Boolean

canModifyAvailability)v getFlatEntryNodesOf (EntryNode en)v checkOutEntry (Entry entry, [String stepPath], [boolean waitForStatus)v getLocationHierarchyNames ([Boolean canModifyAvailability])v getGlobalErrors ()v getItem (int columnIndex)v getModifiedAttributePathsNewEntry ([Category location])v deleteCtgView (CtgView ctgView)v getLocationsChangedToHaveNoData (CategoryTree locationHierarchy)v new$SearchSelection (Catalog catalog, String name)v getDouble (int columnIndex)v moveCursor (int position)v getXMLNodes (String sPath)v getLdapObjectclass ()v new$LdapAttribute (String attributeType, Object attributeValue [, Boolean

isBinary, Boolean isExternal)v getImplclass ()v getAllUsers ()


v getEditableAttributeGroups ([String subViewType], [StringlocationHierarchyName])

v getXMLNodeValues (String nodePath [, Boolean bRequired])v getFloat (int columnIndex)v makeItemUnavailableInLocation (Category location, [Boolean bRecursive])v deleteSearchTemplate ()v getDeletedAttributePathsOldEntry ([Category location])v isExternal ()v setInheriting (Category location, String sAttribPath, [Boolean flag])v setWsddDocPath (String wsddDocPath)v getString (int columnIndex)v setItemLocationAttrib (Category location, String sAttribPath, Object sValue)v scriptArrayFromJavaArray (OneDimensionalJavaArray)v setEntryAttribValues (String sAttribPath, Object[] sValues)v getLdapDistinguishedName ()v executeInBackground (String selectionName)v getLocationForErrors ()v disableEntryValidation(Entry collabAreaEntry, String workflowStepAtPath,

Boolean disableValidation)v isEntryNew()v item.getCtgItemRelatedItemInfo()

Note:

– This script operation was deprecated in WebSphere Product Center V5.2.1– This script operation has been replaced with

entry::getEntryRelationshipAttrib(string attribpath) in InfoSphere MDMCollaboration Server V9.0.0.

v moveUserToOrganization(Category srcOrg,Category dstOrg)v copyUserToOrganizations(Category[] organizations)v removeUserFromOrganization(Category organization)v invocationCacheGet(String key)v invocationCachePut(String key, Object value)v invocationCacheRemove(String key)v invocationCacheClear()v setDynamicSelectionQueryString(String queryString)v getExactAttributePath()

Methods only in V6.5.0 carried forward to V10.0.0This topic lists a method only in IBM InfoSphere Master Data ManagementCollaboration Server V6.5.0 that is carried forward to V10.0.0.v String ExcelCell::getExcelCellEncoding()

Changes in script operations behavior from V5.2.1 and V10.0.0This topic lists the changes in behavior for script operations existing in both theWebSphere Product Center V5.2.1 and IBM InfoSphere Master Data ManagementCollaboration Server V10.0.0 Scripting Libraries.


setEntryNodeValue()Behavior in V5.2.11. Creates a new node if not present.2. Returns the value which was set.

Behavior in V10.0.01. It throws exceptions if the node is not already present, you have to

create a new node by using entry.setEntryAttrib().2. Returns 1/0/-1 based on the action taken (success, nothing changed,

error).

getEntryNode()Behavior in V5.2.11. Whenever a new item/category is created, one occurrence of

MultiAttibute node is present by default.itemNode.getEntryNode("/SpecForMigTest/Multi#0/Sub-Multi#0")

returns the node.2. If the path specified is not found, V5.2.1 creates it and returns the node.

Returns null if path is not valid.

Behavior in V10.0.01. V10.0.0 throws exception if the path is not already present.2. V10.0.0 does not create a node.

setEntryNode()Behavior in V5.2.11. V5.2.1 creates it and returns the node , else returns null if path is not

valid

Behavior in V10.0.01. V10.0.0 throws an exception if the path is not already present.

getEntryNodeChildren()Behavior in V5.2.11. V5.2.1 returns the actual children of grouping node.

itemNode = item.getRootEntryNode(); node = itemNode.setEntryNode("/SpecForMigTest/Multi");

output:SpecForMigTest/Multi/Sub-Multi

Behavior in V10.0.01. V10.0.0 returns the occurrences of Multi and not its actual children for

exampleitemNode = item.getRootEntryNode(); node =itemNode.setEntryNode("/SpecForMigTest/Multi");

output: /SpecForMigTest/Multi#0 /SpecForMigTest/Multi#1

getEntryNodes()Behavior in V5.2.11. V5.2.1 the children are also returned as the paths of children contains

the path specified in the script op.itemNode = item.getRootEntryNode(); nodes =itemNode.getEntryNodes("/SpecForMigTest/Multi"); out.writeln(nodes);

Behavior in V10.0.01. V10.0.0 does not return children.


getEntryNodeParent()Behavior in V5.2.11. V5.2.1 returns the actual parents.

itemNode = item.getRootEntryNode(); node =itemNode.getEntryNodes("/SpecForMigTest/Multi#0/Sub-Multi#0");out.writeln("Node:: " + node[0].getEntryNodePath());out.writeln("Node Parents:: "+ node[0].getEntryNodeParent().getEntryNodePath());

Output:Node:: SpecForMigTest/Multi/Sub-Multi Node Parents:: SpecForMigTest/Multi

Behavior in V10.0.01. V10.0.0 returns the group node instead of actual parent.

itemNode = item.getRootEntryNode(); node =itemNode.getEntryNodes("/SpecForMigTest/Multi#0/Sub-Multi#0");out.writeln("Node:: " + node[0].getEntryNodePath());out.writeln("Node Parents:: "+ node[0].getEntryNodeParent().getEntryNodePath());

Output:Node:: SpecForMigTest/Multi/Sub-Multi Node Parents::SpecForMigTest/Multi/Sub-Multi

getFlatEntryNodes()Behavior in V5.2.11. This method returns an array of flat EntryNodes of this entry.

Behavior in V10.0.0This method raised exceptions in earlier versions and the exceptions werecaused by the script making a call to getEntryNodeValue on the entryNodereturned by getFlatEntryNodes. This is because, now with serialized formwe have a new entrynode returned by getFlatEntryNodes called thedirectory node. For single attributes that are multi-occurring an extraentrynode is returned and its node::type is STRING or whatever theattribute type is. The script attempts to get the value and report it. So, a fixhas been provided in Version 5.3.2 wherein after getFlatEntryNodesreturns the nodes, a new method getEntryNodeType() checks its type. If thetype happens to be V, only then the entry node is processed. Here is theprototype of the method:<prototype>

<![CDATA[String EntryNode::getEntryNodeType()]]></prototype><description>

<![CDATA[return "V" = value, "G" = Grouping or top level of spec directory,"M" = Multi-directory (contains multiple occurrances of values or groupings))]]></description>

The following is an example of the implementation.

ctg1 = getCtgByName( "<catalog name>" );itm1 = ctg1.getCtgItemByPrimaryKey( "<primary key of item>" );ents1 = itm1.getFlatEntryNodes();

for( i=0; i<ents1.size(); i++ ){var val1 = "----";var ent1 = ents1[i];

var ePath1 = ent1.getEntryNodeExactPath();out.write( ePath1 + " " );

var type1 = ent1.getEntryNodeType();out.write( type1 + " " );

if( type1 == "V" ){val1 = "" + ent1.getEntryNodeValue();

}else{


val1 = "" + ent1.getEntryNodeChildren().size();}out.writeln( val1 );

}

setTypeToExport(String sObjectType)Behavior in V5.2.1v COLLABORATION_AREA_CONTENT is an acceptable value for

sObjectType

Behavior in V10.0.0v COLLABORATION_AREA_CONTENT is removed from the list of

acceptable values for sObjectType

addObjectByNameToExport(String sEntityName[, String sObjectType, [StringsActionMode]])

Behavior in V5.2.1v COLLABORATION_AREA_CONTENT is an acceptable value for

sObjectType



addAllObjectsToExport([String sObjectType, [String sActionMode]])Behavior in V5.2.1v COLLABORATION_AREA_CONTENT is an acceptable value for

sObjectType



Changes in script operations behavior existing from V5.3.0.1and V10.0.0

This topic lists the changes in behavior for script operations existing in bothWebSphere Product Center V5.3.0.1 and IBM InfoSphere Master Data ManagementCollaboration Server V10.0.0 Scripting Libraries.

setContainerProperties()Behavior in V5.3.0.1v The properties specified in the PROPERTIES hashmap are set for the

container in question.

Behavior in V10.0.0v The properties specified in the PROPERTIES hashmap are set for the

container in question. Hashmap key "SCRIPT_NAME" is now deprecatedand "POST_SCRIPT_NAME" should be used in its place.

getCategoryAttrib()Behavior in V5.3.0.1v Returns the value of the attribute sAttribPath (spec_name/

attribute_name) of this category.

Behavior in V10.0.0v Returns the value of the attribute sAttribPath (spec_name/

attribute_name) of this category, only when the Attribute is included inthe View or Attribute Collection, otherwise it will return null.


getEntryAttrib()Behavior in V5.3.0.1v Returns the value of the attribute sAttribPath (spec_name/

attribute_name) of this entry.


attribute_name) of this entry, only when the Attribute is included in theView or Attribute Collection, otherwise it will return null.

getCtgItemAttrib()Behavior in V5.3.0.1v Returns the value of the attribute sAttribPath (spec_name/

attribute_name) of this item.


attribute_name) of this item, only when the Attribute is included in theView or Attribute Collection, otherwise it will return null.

removeNode()Behavior in V5.3.0.1v Returns Boolean.

Behavior in V10.0.0v Returns void.

setTypeToExport()Behavior in V5.3.0.1v Sets the object type to be exported.

Behavior in V10.0.0v Sets the object type to be exported.

COLLABORATION_AREA_CONTENT, INHERITANCE_RULESremoved from the list of acceptable values for sObjectType.

addObjectByNameToExport()Behavior in V5.3.0.1v COLLABORATION_AREA_CONTENT is an acceptable value for

sObjectType.


acceptable values for sObjectType.

addAllObjectsToExport()Behavior in V5.3.0.1v COLLABORATION_AREA_CONTENT is an acceptable value for

sObjectType.


acceptable values for sObjectType.

disableContainerProcessingOptions(String[] options)Behavior in V5.3.0.1v Disable the specified processing options.

Behavior in V10.0.0


v Disable the specified processing options. More possible values for theoptions parameter: ENTRY_BUILD_SCRIPT andUNIQUE_VALIDATION.

Changes in script operations behavior from V6.0.0 and V10.0.0This topic lists the changes in behavior for script operations existing in IBMInfoSphere Master Data Management Collaboration Server V6.0.0 and V10.0.0Scripting Libraries.

exportEnv ()Behavior in V6.0.0v Exports the InfoSphere MDM Collaboration Server objects specified in

envObjList at the specified DocStore path. The sDocFilePath variablecontains the path of the .zip file that will be exported into the documentstore. This method returns the log as a string.

Behavior in V10.0.0v Exports the InfoSphere MDM Collaboration Server objects specified in

envObjList at the specified DocStore path. The sDocFilePath variablecontains the path of the .zip file that will be exported into the documentstore. If sDocFilePath is given as "file:///" followed by the path on thefile system, the .zip file will be exported directly to the file system andnot to the docstore. The optional parameter sMapFilePath is the path ofthe name mapping file on the file system which provides the object tofile name mappings for the objects being exported. This method returnsthe log as a string.

Java API differences between various versionsThe base version used for the Java API in IBM InfoSphere Master DataManagement Collaboration Server Version 9.0.0 is WebSphere Product CenterVersion 5.3.2.

Java API methods and enumsThis topic lists the new methods and enums added to interfaces existing in bothIBM InfoSphere MDM Server for PIM V6.0.0, Fix Pack 5, V9.1.0 and IBMInfoSphere Master Data Management Collaboration Server V10.0.

AttributeDefinition.javaenum: AttributeDefinition.Type: RICH_TEXT andEXTERNAL_CONTENT_REFERENCE added

method: public int getId()

AttributeDefinitionProperty.javaenum AttributeDefinitionProperty.Name: GROUP and LOCALE_NODEdeprecated

enum AttributeDefinitionProperty.Name: RICH_TEXT added

AttributeInstance.javamethod: public void setValueUsingJSON(Object value)

AttributeOwner.javamethod: public AttributeInstance getAttributeInstance(int[] nodeIdArray,int[] indexArray, boolean bFollowInheritance, booleancreateOccurrencesIfNeeded)


Item.javamethod: public OrderedJSONObject toJSON(boolean includeAttributeType)

method: public void addStatusAndAvailability(OrderedJSONObjectitemJSONObj)

Catalog.javamethod: public PIMCollection<Item> getItems(int[] itemIds)

method: public PIMCollection<Item> getItems(Object[] itemIds)

method: public void setIgnoreCache(boolean ignoreCache)

method: public boolean getIgnoreCache()

method: public boolean isCached()

method: public void setCached(boolean setCached)

method: public OrderedJSONObject toJSON()

CatalogManager.javamethod: public Catalog getCatalog(String catalogName, booleanreturnItem)

method: public Catalog getCatalog(int catalogId)

method: public Catalog getCatalog(int catalogId, boolean returnItem)

CategoryCollaborationArea.javamethod: public CollaborationCategory createCollaborationCategory()

CollaborationCategory.javaenum: CollaborationCategory.SaveResult

method: public SaveResult getSaveResult()

method: public Collection<SecondarySpec> getItemSecondarySpecs()

method: public OrderedJSONObject toJSON(boolean includeAttributeType)

method: public void addStatusAndAvailability(OrderedJSONObject

collaborationCategoryJSONObj)method: public void addItemSecondarySpec(SecondarySpec spec,Collection<Catalog> catalogs, boolean addToChildCategories, booleanaddAcrossMapping)

method: public void addSecondarySpec(SecondarySpec spec)

method: public void removeItemSecondarySpec(SecondarySpec spec)

CollaborationItem.javamethod: public OrderedJSONObject toJSON(boolean includeAttributeType)

method:public void addStatusAndAvailability(OrderedJSONObjectcollaborationItemJSONObj)

CollaborationStep.javamethod: public CollaborationObject getCollaborationObject(int id)

enum ValidationError.TypeThese are added: TOTAL_DIGITS, MIN_EXCLUSIVE, MIN_INCLUSIVE,MAX_EXCLUSIVE, MAX_INCLUSIVE

Context.javamethod: SearchQuery createSearchQuery(String queryString,Collection<Item> items, Catalog catalog)


method: public String setSavepoint()

method: void rollbackToSavepoint(String name)

method: public SearchHelper getSearchHelper()

method: public HistoryManager getHistoryManager()

method: public MessageBundle getMessageBundle()

method: public MessageBundle getMessageBundle(Locale locale)

Category.javaenum: Category.SaveResult

method: public Collection<String[]> getFullDisplayPaths()

method: public Collection<Integer> getSecondarySpecIdsForChildren()

method: public OrderedJSONObject toJSON(boolean includeAttributeType)

method: public void addStatusAndAvailability(OrderedJSONObjectcategoryJSONObj)

Hierarchy.javamethod: public Category createCategory()

method: public PIMCollection<Category> getCategories(int[] categoryIds)

method: public PIMCollection<Category> getCategories(Object[]categoryIds)

method: public OrderedJSONObject toJSON()

HierarchyManager.javamethod: public Hierarchy getHierarchy(int hierarchyId)

OrganizationManager.javamethod: public OrganizationHierarchy getOrganizationHierarchy(int id)

SearchQuery.javaenum SearchQuery.ColumnType : LOGENTRY added enum:SearchQuery.SearchQueryOp

SearchResultSet.javamethod: public UserDefinedLogEntry getUserDefinedLogEntry(intcolumnIndex) throws PIMSearchException

SelectionManager.javamethod: public Selection getSelection(int selectionId)

Spec.javamethod: public AttributeDefinition getAttributeDefinition(intattributeDefinitionId)

SpecManager.javamethod: public Spec getSpec(int specId)

EnvironmentExporter.javamethod: public String export(ExportList exportList, String documentPath,String mappingPath)

method: public String export(ExportList exportList, String documentPath,boolean

checkForRequisites, String mappingPath)method: public String exportAll(String documentPath, String mappingPath)


New Java API interfacesThis topic lists the new interfaces introduced in IBM InfoSphere MDM Server forPIM V9.1.0 and IBM InfoSphere Master Data Management Collaboration ServerV10.0.v Filterv PIMObjectv HistoryManagerv CMSContentURNv CMSInstancev CMSManagerv AuthorizationHelperv SavedSearchv SearchHelperv LeftPaneDataObjectv LeftPaneDataObjectFactoryv RichTextEditorv MessageBundlev PackagingTool

Tuning your databaseYou must tune your database by increasing the heap size setting if the databaseserver being used is IBM DB2,

Before you begin

Before you can tune your DB2 database, you must log in as the DB2 administrator.

Procedure

Run the following commands to increase the heap size setting.db2 update database configuration for database <dbname> using applheapsz 8192db2 update database configuration for database <dbname> using app_ctl_heap_sz 8192db2 update database configuration for database <dbname> using LOGFILSIZ 4000

where dbname is the actual name of the DB2 db instance. You can find the currentvalues of these parameters using the following commands:db2 get dbm cfgdb2 get db cfg for <dbname>

Note: The above numbers in DB2 commands are indicative only. You need to getthe correct parameter values for your environment from your DBA.

Transforming the data model metadataYou must transform the metadata of WebSphere Product Center V5.2.1.4 for use inIBM InfoSphere Master Data Management Collaboration Server V9.1.0.


About this task

WebSphere Product Center V5.2.1.4 and InfoSphere MDM Collaboration ServerV9.1.0. store data and handle data models differently. To ensure that metadataconforms to InfoSphere MDM Collaboration Server V9.1.0 standards, you musttransform the metadata.

To transform the data, you can use the migrateCompanyZip.sh script. This scriptreads the compressed file that was generated by the export process, checks for datamodel incompatibility issues in the contents of the compressed file, and creates anew compressed file with the same name that you can import into a InfoSphereMDM Collaboration Server V9.1.0 instance. The shell script internally uses XSLtransformations that are started based on the content of the compressed file.

When you run this script, you can also specify an XML file that defines theattributes that must be searchable at run time for the target company. This featurewas introduced to improve performance.

Before you migrate data, ensure that all attributes that you want to be searchableat run time are defined as RTS. If an attribute is changed to RTS after themigration through the Spec console, all the items that were migrated or createdbefore this change must be saved again to make them RTS. This task might requireconsiderable effort if there are many such items. It is advisable to check for theseattributes before migration.

Procedure

Run the migrateCompanyZip.sh script. This script is in the $TOP/bin directory.migrateCompanyZip.sh [--debug=yes] [--verbose=yes][--param=<filename>] --out=<output directory> <input zip>

In this example, the migrateCompanyZip.sh transforms the content of thecompanySpecs.zip file and uses the params.xml file to identify all the attributes thatmust be runtime searchable (RTS) in the target company.$TOP/bin/migrateCompanyZip.sh --debug=yes --verbose=yes--param=$TOP/params.xml --out=$TOP/out $TOP/input/companySpecs.zip

where $TOP specifies the InfoSphere MDM Collaboration Server installationdirectory.

XSLT transformer correctionsThe XSLT transformer is designed to correct selective errors.

Spec Changes

IBM InfoSphere Master Data Management Collaboration Server V9.1.0 does notsupport the following:v The PERIOD SpecNode type - If you migrate from WebSphere Product Center

V5.2.1.x and use the PERIOD SpecNode type then the migration utility willconvert the PERIOD SpecNode type to GROUP.

v A SpecNode with the attribute value NULL. For example, SpecNode attributesMAX_INCLUSIVE, SCALE, MAX_EXCLUSIVE; MIN_EXCLUSIVE can not havea NULL value. The transformation utility deletes such attribute properties.


Workflow Changes

InfoSphere MDM Collaboration Server V9.1.0 does not have the StepTypePARTIAL_UNDO. The equivalent replacement is INTERIM_CHECKOUT.Therefore, the transformation utility will convert all occurrences ofPARTIAL_UNDO step type to INTERIM_CHECKOUT.

Attributes to associate with steps

In WPC V5.2.1.x only steps PARTIAL_UNDO and MODIFY were constrained tohave attribute collections associated with them.

In InfoSphere MDM Collaboration Server V9.1.0 the steps AUTOMATED,INTERIM_CHECKOUT, AND_APPROVAL, MODIFY, INTERIM_CHECKIN,GENERAL, OR_APPROVAL, and DISPATCH are constrained to have an attributecollection associated with them.

Before importing a workflow, you must modify the XML in the zip file for thetypes of steps described above by including a relevant attribute collection. TheXML will look similar to:<Step>....

<StepType>AUTOMATED</StepType>....

<EditableAttributesCollections><ItemEdit>

<AttributeCollection>Attribute Collection 1</AttributeCollection></ItemEdit>

</EditableAttributesCollections>....</Step>

Collaboration Area Left Pane

In InfoSphere MDM Collaboration Server V9.1.0, collaboration areas are availablein the left pane just like catalogs and hierarchies. This is a quick way of navigatingto a different step without having to go to the collaboration area console.

Workflow Engine recovery on startup

Starting with WPC V5.3, when the workflow engine starts up, any workflowevents that are still marked as PROCESSING are now set to ERROR to indicatethat there was a problem. This is more important now as most workflow eventprocessing is done on the workflow engine rather than the application server.

Attribute Validation in Workflow

In InfoSphere MDM Collaboration Server V9.1.0, attribute collections can beassigned on each step in a workflow. In earlier versions of WPC, a user wouldselect an attribute collection for the entire workflow.

Attributes to validate

Starting with WPC V5.3, each step has up to three attribute collections assigned:v View – allows the values of these attributes to be viewed.v Edit – allows the values of these attributes to be viewed and edited. On Save,

these attributes are verified against rules defined in the Spec.


v Required – these attributes can be viewed and edited. A value must be providedfor all required attributes. On Save, these attributes are verified against rulesdefined in the Spec.

Workflow validation rules in InfoSphere MDM CollaborationServer V9.1.0v An item will be not allowed to move to the next step unless it is considered

valid by the rules of the step being exited. This is the most important rule. Inother words, source container validation rules, particularly required attributes,will be overridden by the workflow's validation settings. For example, arequired attribute such as MinOccurs=1 will be overridden by the workflow'svalidation settings

v Attributes that are required and can be modified in the workflow, must beadded to a required attribute collection on those steps where they can bemodified, even if a rule is specified on the Spec.

v Every item must have a unique primary key.v Every object must be unique within the collaboration area, until check in, at

which the point source container key uniqueness is checked.v An entry that conflicts with an entry in the source container will be routed to

FIXIT.v Only editable or required attributes within a step are validated.

Save-as-draft

In WPC V5.3 you can save invalid data within a workflow step and return to thatstep later. In earlier versions, data was lost when you navigated away from thescreen if there were any invalid attributes. This happens if Save or Done has beenclicked, causing validation errors to be displayed on the screen. Save-as-draft willonly work on values that pass type conversion. For the save-as-draft option towork, the primary key must be valid and unique within the collaboration area. Youcannot move an entry with invalid data to the next step until you have fixed it,since an entry must be valid by the rules of the step for a successful exit.

Pitfalls of save-as-draft

When an entry leaves a step via a timeout trigger or is sent to FIXIT, no validationis performed. Ensure that you assign all attributes touched by the workflow aseditable attributes to validate on the FIXIT step. Otherwise, you will not be able tosee or correct invalid attributes. The only options would then be:v Check in invalid datav Drop the item from the collaboration area

Ensure that the target step of any timeout includes all attributes that could havebeen modified before the timeout is triggered. This requires a great deal of carewith timeout chains, or nested workflow timeout escalations. If in doubt, includeall attributes.

Handling Ghost Items

In WPC V5.2.1.1, most causes of ghost items were eliminated. Note that ghostcategories were not addressed. A number of changes were made since then:v Enhancements to transactional logic during step transitions to ensure an

all-or-nothing approach to workflow table updates done in one transaction.


v One workflow engine limit is now enforced to reduce conflicts.v Connection isolation of step scripts.v Step scripts now run in separate database connections, so that their failure does

not affect workflow table updates.v Workflow processing now all done asynchronously on the workflow engine

rather than synchronously on the application server. This also ensures aworkflow transition is recorded in the database before it executes, enablingbetter recovery and error handling.

Docstore Changes

The following files are removed from the DOCSTORE.xml file of the WPC V5.2.1exported zip file while running the transformation utility, migrateCompanyZip.sh,on the WPC V5.2.1 exported zip. So this file will not be migrated to InfoSphereMDM Collaboration Server V9.1.0. You must migrate it manually if you need tobring the file changes to InfoSphere MDM Collaboration Server V9.1.0./scripts/import/ctg/environment_catalog_content_import.script/scripts/import/ctr/environment_category_tree_content_import.script/scripts/logout/Logout.wpcs/scripts/login/Login.wpcs/scripts/triggers/LDAPLibrary.wpcs/scripts/triggers/LdapLibraryLogger.wpcs

Scripts associated to default steps in a workflow are renamed to their uppercasecounterparts. For example, the Fixit script is renamed as FIXIT.

Manually migrating your scriptsBefore you import data for the target company, you must ensure that the scriptsthat you migrated function correctly.

About this task

You can identify and rectify most of the syntax level errors like signature changesand missing return values by compiling scripts. You can use thecheckForCompileError.sh script to compile scripts automatically. Running thisscript generates a report that lists the errors for each of the scripts. Refer toCompiling and debugging InfoSphere MDM Collaboration Server scripts for acomplete list of script level changes in signature and behavior, and common issuesand their resolution.

Procedure1. Run the checkForCompileError.sh script. This script is in the $TOP/bin

directory.$TOP/bin/checkForCompileError.sh --company_code=<code>--script_dir=<path/to/wpc/script/directory> --logfile=<logfile path>

This script takes the directory where all scripts are stored as an argument andtries to compile each script in the directory and its subdirectories. In thisexample, the checkForCompileError.sh script is run to compile the scripts inthe /scripts directory. To check all scripts in the /scripts directory by usingthe compiled_only script mode, you must modify the common.properties file toset the script_execution_mode=compiled_only and then run thecheckForCompileError.sh script.$TOP/bin/checkForCompileError.sh --company_code=test--script_dir=/scripts --logfile=logfile.txt


The logfile.txt file is generated. At the end of the file, you will see a report inthe following format:Fri Jan 07 15:25:06 IST 2011 - ********************************************Fri Jan 07 15:25:06 IST 2011 - Script Mode : ’compiled_only’Fri Jan 07 15:25:06 IST 2011 - Total Scripts : ’10’Fri Jan 07 15:25:06 IST 2011 - Successful : ’8’Fri Jan 07 15:25:06 IST 2011 - Failed : ’2’Fri Jan 07 15:25:06 IST 2011 - /scripts/import/ctr/abhitest -The script could not be compiled.Fri Jan 07 15:25:06 IST 2011 - /scripts/import/ctr/AbhiFailureWrongScript -The script object could not be built.[[Undefined operation: getEntryAttribs at line 3]]Fri Jan 07 15:25:06 IST 2011 - ********************************************

2. Run the checkChangedScriptOps.sh to get a list of scripts that were in terms ofsignature or behavior with respect to WebSphere Product Center v5.2 and its fixpacks, or removed from WebSphere Product Center V5.3.x. This script isavailable in the $TOP/bin directory. script. is For more information aboutchanges to how the scripts operate, see the InfoSphere MDM CollaborationServer information center. This script helps in initial estimation and later in theimplementation phase where you can get a list of scripts which would requiremore attention and exact location within the script where changes are likely tobe done.$TOP/bin/checkChangedScriptOps.sh --company_code=<company code>--use_docstore=<yes/no> --src_path=<source path>[--dst_path=<destination path>] --logfile=<log file path>

dst_pathSpecifies the destination path. This is an optional parameter. If you donot provide this as an argument, the script scans and overwrites allscripts in source folder that is specified by src_path parameter.

logfile Specifies the log file details in the following format:

<complete path of the script file > <line no> <name of the deprecated scriptoperation>

CommentSpecifies a comment that is specific to the particular deprecated scriptoperation.

When the dst_path argument is supplied to the shell script, it modifies thesource script by adding comments above the occurrences of deprecated scriptoperations and writes the modified script to the destination location. All scriptmodifications are tagged with the following text: //modified_bywpc_automated_tool for easy identification.When the use_docstore parameter is set to no, the company_code parameter isnot required. If you provide a value, the value is ignored.Runtime errors comprise type mismatches because InfoSphere MDMCollaboration Server V9.1.0 has enforced scripting to be more of a typedlanguage where a variable cannot store values of unrelated types. Since there isa behavior change in a few script operations, the values returned might causeunexpected errors. You must deal with these errors on a case by case basis. Formore information about script changes, see Compiling and debuggingInfoSphere MDM Collaboration Server scripts.

Note: Although this utility does not handle script API changes that occurredafter WPC v5.3.2, you might want to identify any differences between WPCV5.2.1.4 and V5.3.2 script operations.


Chapter 6. Troubleshooting

You can use the recommended solutions to resolve common migration issues.

Troubleshooting the migration scriptsYou need to compile migration scripts before you can view them in the scriptconsole of IBM InfoSphere Master Data Management Collaboration Server, and runthem. You can also use InfoSphere MDM Collaboration Server facilities totroubleshoot your scripts.

Using compiled migration scriptsYou need to modify the common.properties file before using compiled scripts.

To use compiled scripts, make sure that the common.properties file in the$TOP/etc/default directory has the following setting:script_execution_mode = compiled_only

You can disable script compilation for individual scripts by including the followingdirective at the beginning of the script:script_execution_mode=not_compiled

However, disabling script compilation at the script level is not recommendedbecause it leads to significant performance degradation. To avoid performancedegradation when using non-compiled scripts, change your server setting tonot_compiled rather than using the option of disabling compilation at the scriptlevel.

If the server setting in the common.properties file is set to not_compiled, then thescript compilation for individual scripts cannot be enabled using script leveldirectives.

Note: Using a combination of compiled and non-compiled scripts will degradeperformance, and it is NOT recommended. However, if you must use thiscombination, there is a limitation: a non-compiled script can invoke functions in acompiled script, but a compiled script cannot invoke a function in a non-compiledscript.

Common script compilation errorsWhen using compiled scripts, a script can be saved in the script console only if itcompiles correctly. If there is an error, check svc.out in the appsvr logs directoryfor the full javac output and error message.

The following are some common compilation errors:1. A break or return statement inside a forEach*Element() block does not compile

due to an "unreachable code" error. To fix this issue:forEachItemSetElement(itemSet, item){

return item;}

Change it to:


forEachItemSetElement(itemSet, item){if (item != null){

return item;}

}

This is equivalent, but satisfies the compiler.2. If you return a value from a function, you need to return a value in every case.

In other words, this doesn't compile:function sample() {var e = null;catchError (e) {// do something...return "a string";} if (e != null) {reportError(...);}}

Since it doesn't return a value if an exception happens in the catchError block.You'll need to change it to:function sample() {var e = null;catchError (e) {// do something...

return "a string";}if (e != null) {reportError(...);}return null;}

3. For major compilation issues, you can look at the generated Java files. Thesegenerated Java files are in a directory specified by parameter tmp_dir incommon.properties. The Java file naming convention has recently been changedto include the script name and a generated sequence, for example:MyScript12345.java.

4. Additionally, the full path of the script from the docstore is placed as acomment at the top of each generated Java file. If you are mapping the docstoreto the file system, you can run a recursive grep command to find out whichJava file matches a script.

Common runtime errors and problemsThere are some known issues you may encounter when you are running scripts.These examples illustrate some of those known issues and provide some insightson avoiding or resolving them.

Invalid argument type:This occurs when you are passing the wrong type of argument to afunction (for example, a HashMap when it requires a String). This alsohappens if IBM InfoSphere Master Data Management Collaboration Servercannot infer the type correctly. To resolve this, you may need to use ascript operation such as checkString() to make the type explicit.

Mismatched argument types in comparisons:


If the same data type, such as ==, >, <, <= and so on, does not appear onboth sides of a conditional operator, the expression will evaluate to false.This does not result in an error message, but the corresponding code willnot be run.

For example, the following will not work:var id = “12345” ;var my_id = item.getEntryAttrib(path to some attribute that is a sequence) ;if ( id == my_id) {// statements that need to be executed but won’t be}

The solution in this case is to explicitly use:var id = “12345” ;var my_id = checkString(item.getEntryAttrib(//some attribute that is a sequence),””) ;if ( id == my_id) {// statements to be executed}

XML parsing:

The following code works in non-compiled mode and even in compiledmode when run from the Script Sandbox:new XmlDocument(xmlDoc) ;forEachXmlNode("item") {// do the needful}

However, in compiled mode, if this code is used in a script library functionthat is invoked by multiple users, then the statements inside theforEachXmlNode block do not get executed. There is no error message. Theworkaround is to use the following:var doc = new new XmlDocument(xmlDoc) ;var xmlNode ; forEachXmlNode(doc, "item", xmlNode) {//do the needful}

Resolving runtime errors and problemsTo resolve run time errors on the appserver, refer to the file svc.out in the appsvrlog directory. Sometimes, examining the exception.log and the default.log maybe helpful.

With the new generated Java file naming convention, it is easy to identify whichscript failed. The error message also identifies the line number in the generatedJava file. To resolve the problem, view the generated Java file and scroll to the linewhere the runtime error occurred. The generated Java code now includes actualscript code as comments every few lines.

For example, consider the following portion of code from a sample generated Javafile:// function checkIfPartyPartyTypeExist(party, partyType)public static Object ScriptFunction__checkIfPartyPartyTypeExist(HashMap hmContext, Object party, ObjectpartyType) throws Exception{// var bRet = false;Object bRet = (java.lang.Boolean) Boolean.FALSE; //var rootEntry = party.getRootEntryNode();Object rootEntry = GenGetRootEntryNodeOperation.execute(hmContext , (IEntry) party);// var entryNodes = rootEntry.getEntryNodes(getCatalogSpecName() + "/Party Types/Party Type Code");Object entryNodes = GenGetEntryNodesOperation.execute(hmContext , (EntryNode) rootEntry, (String)BinaryOperation.execute(BinaryOperation.PLUS, ScriptFunction__getCatalogSpecName(hmContext), "/PartyTypes/Party Type Code"));// var entryNodesSize = entryNodes.size();Object entryNodesSize = (java.lang.Integer) GenSizeOperation.execute(hmContext , (HashMap) entryNodes);

Each of the lines beginning with // in the comments above are actual code from thecorresponding IBM InfoSphere Master Data Management Collaboration Serverscript. This makes it easy to identify where failure occurred in the script.

Chapter 6. Troubleshooting 75

Using checkForCompileError.shYou must check your scripts for compilation errors.

Ensure that you correct all errors caught during compilation before starting animport in the target company.

checkForCompileError.sh is provided to enable automated script compilation.

The usage is as follows:checkForCompileError.sh --company_code=<code> --script_dir=<path/to/wpc/script/directory> --logfile=<logfile path>

This command takes a script_dir (docstore path) as an argument where all thescripts are present. This script tries to compile each of the scripts present in aspecified script directory and its subdirectories and generates a report that willcontain the script name and the errors.

If you want to check all scripts available in the /scripts/import/ctr/ docstoredirectory using the compiled_only script mode, first modify the common.propertiesfile to have the script_execution_mode=compiled_only value and run thecheckForCompileError.sh from the $TOP directory../bin/checkForCompileError.sh --company_code=test --script_dir=/scripts --logfile=logfile.txt

It will generate a logfile.txt file, and at the end of the file you will see report infollowing format:Fri Jul 21 15:25:06 IST 2006 - ********************************************Fri Jul 21 15:25:06 IST 2006 - Script Mode : ’compiled_only’Fri Jul 21 15:25:06 IST 2006 - Total Scripts : ’10’Fri Jul 21 15:25:06 IST 2006 - Successful : ’8’Fri Jul 21 15:25:06 IST 2006 - Failed : ’2’Fri Jul 21 15:25:06 IST 2006 - /scripts/import/ctr/abhitest - The script could not becompiled.Fri Jul 21 15:25:06 IST 2006 - /scripts/import/ctr/AbhiFailureWrongScript - The scriptobject could not be built. [[Undefined operation: getEntryAttribs at line 3]]Fri Jul 21 15:25:06 IST 2006 - ********************************************

Troubleshooting migration issuesDescribes some common issues for troubleshooting that might come up duringmigration in IBM InfoSphere Master Data Management Collaboration Server.

Issue: Missing indexes

When migrating to InfoSphere MDM Collaboration Server, Version 10.0.0, youmight see missing indexes in the migration console report.

The following errors related to missing indexes might occur during migrating:

Missing indexes on the SCA tableMissing Indexes|============================================================|SCA_0_PK SCA_CATEGORY_IDSCA_SELECTION_IDSCA_COMPANY_IDSCA_|CATALOG_IDSCA_CAT_TREE_ID

You can run this PERL script to resolve this issue. Choose directory db2 ororacle appropriately.perl $PERL5LIB/runSQL.pl --sql_file=$TOP/src/db/schema/dbscripts/<db2 or oracle>/sca_pk.sql


Missing indexes on the DBV tableMissing Indexes|============================================================|DBV_0_UK DBV_VERSION

You can run this PERL script to resolve this issue. Choose directory db2 ororacle appropriately.perl $PERL5LIB/runSQL.pl --sql_file=$TOP/src/db/schema/gen/<db2 or oracle>/ddl_ver_synchronize.sql. $TOP/bin/compat.sh$JAVA_RT com.ibm.ccd.synchronize.DBSchemaVersion --autoupd

Missing indexes on the DOA and CTG tables (DB2 only)Missing Indexes|==============================================| CTG_1_UK CTG_COMPANY_IDCTG_NAME| DOA_0_UK DOA_DOC_IDDOA_CMP_IDDOA_NAME

You can run this PERL script to resolve this issue:perl $PERL5LIB/runSQL.pl--sql_command="alter table tctg_ctg_catalog drop constraint ctg_1_uk ;"perl $PERL5LIB/runSQL.pl--sql_command="drop index ictg_ctg_2;"

perl $PERL5LIB/runSQL.pl--sql_command="alter table tctg_ctg_catalogadd constraint ctg_1_uk unique (ctg_company_id, ctg_name);"

perl $PERL5LIB/runSQL.pl--sql_command="create index ictg_ctg_2 ontctg_ctg_catalog ( ctg_name, ctg_company_id)ALLOW REVERSE SCANS;"

perl $PERL5LIB/runSQL.pl--sql_command="alter table TDOC_DOA_DOC_ATTRIBUTESdrop constraint doa_0_uk ;"

perl $PERL5LIB/runSQL.pl--sql_command="drop index idoc_doa_0;"

perl $PERL5LIB/runSQL.pl--sql_command="alter table tdoc_doa_doc_attributesadd constraint doa_0_uk unique (doa_doc_id, doa_cmp_id, doa_name);"

perl $PERL5LIB/runSQL.pl--sql_command="create index idoc_doa_0on tdoc_doa_doc_attributes ( doa_name, doa_doc_id, doa_cmp_id)ALLOW REVERSE SCANS;"

Issue: Missing tables ITX and CAX

When migrating to InfoSphere MDM Collaboration Server, Version 10.0.0, youmight see this error in the DB verification report:___________________________________________________________|Missing Tables|===========================================================| TCTG_CAX_CATEGORY_CONTENT| TCTG_ITX_ITEM_CONTENT

|Missing Indexes|| CAX_0_PK CAX_ENTRY_IDCAX_NEXT_VERSION_ID| ITX_0_PK ITX_ENTRY_IDITX_NEXT_VERSION_ID

Chapter 6. Troubleshooting 77

This error indicates a problem with table space creation, XDB installation, or dbparameters. Check in the errfile.log file in the $TOP/logs directory for the exactmessage. Ensure that database setup is done correctly and then run the migrationscript again.

Issue: Insufficient privileges error

When running a migration script for migrating to InfoSphere MDM CollaborationServer, Version 10.0.0, you might see an Insufficient privileges error in the console.Typical examples of the error are:

Oracle databaseWhen using an Oracle database, the error might look like this error:create index icnt_eem_2 on tcnt_eem_entry_entry_map (

*ERROR at line 1:ORA-01031: insufficient privileges

DB2 databaseWhen using a DB2 database, the error might look like this error:SQL0551N "USERNAME" does not have the privilege to perform operation"CREATE INDEX" on object "USERNAME.TWFL_WFE_WORKFLOW_EVENT". SQLSTATE=42501

The database user does not have enough privileges to create an index in thedatabase. You must grant "create index" privilege to the database user and thenrun the migration script again. You must also grant access to the user to be able tocreate and modify tables.

Issue: Migration script failure

When running a migration script for migrating to InfoSphere MDM CollaborationServer, Version 10.0.0, the script might fail. A typical scenario of script failure is:

Failure in module data_maintenance_reports-----------------------------------------------------------Summary of the migration-----------------------------------------------------------Migration of the following modules failed:data_maintenance_reports

The $TOP/logs/errfile.log file contains the following content:net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatReceiver$MulticastReceiverThreadrunSEVERE: Multicast receiver thread caught throwable. Cause was null. Continuing...

This is because there is an issue with the cache configuration parameters, butmigration script continued and completed successfully. Check your cacheconfiguration parameters. No need to rerun the migration script.


Notices

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan, Ltd.1623-14, Shimotsuruma, Yamato-shiKanagawa 242-8502 Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.


IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM CorporationJ46A/G4555 Bailey AvenueSan Jose, CA 95141-1003U.S.A.

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this information and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement, or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. The sampleprograms are provided "AS IS", without warranty of any kind. IBM shall not beliable for any damages arising out of your use of the sample programs.


Each copy or any portion of these sample programs or any derivative work, mustinclude a copyright notice as follows:

© (your company name) (year). Portions of this code are derived from IBM Corp.Sample Programs. © Copyright IBM Corp. _enter the year or years_. All rightsreserved.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

TrademarksIBM, the IBM logo, and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corporation in the United States, other countries,or both.

IBM, the IBM logo, and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and service names might be trademarks of IBM or other companies.A current list of IBM trademarks is available on the Web at "Copyright andtrademark information" at www.ibm.com/legal/copytrade.shtml.

Adobe is either registered trademarks or trademarks of Adobe SystemsIncorporated in the United States, and/or other countries.

Java and all Java-based trademarks and logos are trademarks of Sun Microsystems,Inc. in the United States, other countries, or both.

Intel, Intel Centrino, Celeron, Intel Xeon, Itanium, and Pentium are trademarks orregistered trademarks of Intel Corporation or its subsidiaries in the United Statesand other countries.

Linux is a registered trademark of Linus Torvalds in the United States, othercountries, or both.

Microsoft and Windows are trademarks of Microsoft Corporation in the UnitedStates, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and othercountries.

Other product and service names might be trademarks of IBM or other companies.

Notices 81

http://www.ibm.com/legal/copytrade.shtml

Index

Numerics10.0 6410.0.0 48, 495.3.0.1 486.0.0 499.1.0 64, 67

Aadditional 23

Bbackup 25

Ccatalog content

gds 39check 71clean up 21comments

sending vcompiling 41

Ddata model

gds 68database

gds 25, 67debugging 41

gds 41docstore 33

Eenvironment

GDS 26, 34export 26, 33export script

GDS 31

Ffeatures

new in Version 10.0 v

Ggds 25GDS 20

data 21GDS V1.3.x 20gds.properties

gds 24

Hhierarchy content

gds 39

Iimplementation scripts

GDS 23import 34, 39import script

gds 39importing data 76include 23

Jjava api

10.0 676.0.0 64enums 64interfaces 67methods 64

Java api differences 64

Llimitations 31, 39

Mmetadata 68methods

in V9.0.0 59only in V6.5.0 carried forward to

V10.0.0 59migrate 20

GDS 1.3.x 20migrated environment

gds 40MigrateExport.sh script 26migrating

check for compilation errors 76getting started 3migrating from prior versions 9migrating from v5.3.2 to v10.0.0 12migrating from v6.0.0 to v10.0.0 14migrating from v9.0.0 to v10.0.0 16migrating from v9.1.0 to v10.0.0 18scripts 45troubleshooting migration scripts 73

migrationissues 73overview 1scripts 73

migration scriptsgds 71

Pprepare 20prerequisite information v

Rrelated information vremove 23

Sscript

5.3.0 48differences 48, 49methods in V10.0.0 50methods in V5.3.0.1 50

script differences 45scripts

changes in behavior from V5.2.1 andV10.0.0 60

changes in behavior from V5.3.0.1 andV10.0.0 62

changes in behavior from V6.0.0 andV10.0.0 64

common compilation errors 73common runtime errors 74compiling and debugging 73differences in V5.2.1 and V10.0.0 46methods in V10.0.0 55methods in V5.2.1 49resolving runtime errors 75

searchable attributesgds 23

sending comments vstop 25

Ttrademarks 81transformer

GDS 68transforming 68troubleshooting

contacting IBM Software Support vimigration issues 76

tune 67

Uupdate 24

Vverify 40

XXSLT 68


��

Printed in USA

SC19-3498-00

infosphere mdm collaboration server: migration guide · vi infosphere mdm collaboration server:...

Documents