Contents

List of Examples

List of Figures

List of Tables

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction to Knowledge Modules

• 1.1 What is a Knowledge Module?
• 1.2 Reverse-Engineering Knowledge Modules (RKM)
• 1.3 Check Knowledge Modules (CKM)
• 1.4 Loading Knowledge Modules (LKM)
• 1.5 Integration Knowledge Modules (IKM)
• 1.6 Extract Knowledge Modules (XKM)
• 1.7 Journalizing Knowledge Modules (JKM)
• 1.8 Service Knowledge Modules (SKM)
• 1.9 Guidelines for Knowledge Module Developers

2 Introduction to Component KMs

• 2.1 What is a Component KM?
• 2.2 Syntax Elements of Component KMs
• 2.3 Component KM — Flow Control Commands
• 2.4 Global Templates
• 2.5 KM Inheritance
• 2.6 Groovy Variable Definition Scripts
• 2.7 Structured Substitution API
• 2.8 Task Control Objects
• 2.9 Seeded Component KMs

3 Introduction to OdiRef Substitution API

• 3.1 Introduction to the Substitution API
• 3.2 Using Substitution Methods
  • 3.2.1 Generic Syntax
  • 3.2.2 Specific Syntax for CKM
  • 3.2.3 Using Flexfields
  • 3.2.4 Using Code Generation Tags
• 3.3 Using Substitution Methods in Actions
  • 3.3.1 Action Lines Code
  • 3.3.2 Action Calls Method
• 3.4 Working with Object Names
• 3.5 Working with Lists of Tables, Columns and Expressions
  • 3.5.1 Using INSERT.getTargetColList to create a table
  • 3.5.2 Using getTargetColList to create a table
  • 3.5.3 Using getColList in an Insert values statement
  • 3.5.4 Using getSrcTableList
• 3.6 Generating the Source Select Statement
• 3.7 Obtaining Other Information with the API
• 3.8 Advanced Techniques for Code Generation

4 Reverse-Engineering Strategies

• 4.1 Customized Reverse-Engineering Process
  • 4.1.1 SNP_REV tables
  • 4.1.2 Customized Reverse-Engineering Strategy
• 4.2 Case Studies
  • 4.2.1 RKM Oracle
    • 4.2.1.1 Reset SNP_REV Tables
    • 4.2.1.2 Get Tables
    • 4.2.1.3 Get views, partitions, columns, FK, Keys and other Oracle Metadata
    • 4.2.1.4 Set Metadata

5 Data Integrity Strategies

• 5.1 Data Integrity Check Process
  • 5.1.1 Check Knowledge Module Overview
  • 5.1.2 Error Tables Structures
    • 5.1.2.1 Error Table Structure
    • 5.1.2.2 Summary Table Structure
• 5.2 Case Studies
  • 5.2.1 Oracle CKM
    • 5.2.1.1 Drop Check Table
    • 5.2.1.2 Create Check Table
    • 5.2.1.3 Create Error Table
    • 5.2.1.4 Insert PK Errors
    • 5.2.1.5 Delete Errors from Controlled Table
  • 5.2.2 Dynamically Create Non-Existing References
    • 5.2.2.1 Use Case
    • 5.2.2.2 Discussion
    • 5.2.2.3 Implementation Details
      • 5.2.2.3.1 Create Errors Table
      • 5.2.2.3.2 Insert FK Errors
      • 5.2.2.3.3 Insert Missing References
      • 5.2.2.3.4 Delete Errors from Controlled Table

6 Loading Strategies

• 6.1 Loading Process
  • 6.1.1 Loading Process Overview
  • 6.1.2 Loading Table Structure
  • 6.1.3 Loading Method
    • 6.1.3.1 Loading Using the Agent
    • 6.1.3.2 Loading File Using Loaders
    • 6.1.3.3 Loading Using Unload/Load
    • 6.1.3.4 Loading Using RDBMS-Specific Strategies
• 6.2 Case Studies
  • 6.2.1 LKM SQL to SQL
    • 6.2.1.1 Drop Work Table
    • 6.2.1.2 Create Work Table
    • 6.2.1.3 Load Data
    • 6.2.1.4 Drop Work Table

7 Integration Strategies

• 7.1 Integration Process
  • 7.1.1 Integration Process Overview
  • 7.1.2 Integration Strategies
    • 7.1.2.1 Strategies with Staging Area on the Target
      • 7.1.2.1.1 Append
      • 7.1.2.1.2 Control Append
      • 7.1.2.1.3 Incremental Update
      • 7.1.2.1.4 Slowly Changing Dimensions
    • 7.1.2.2 Strategies with the Staging Area Different from the Target
      • 7.1.2.2.1 File to Server Append
      • 7.1.2.2.2 Server to Server Append
      • 7.1.2.2.3 Server to File or JMS Append
• 7.2 Case Studies
  • 7.2.1 Simple Replace or Append
    • 7.2.1.1 Delete Target Table
    • 7.2.1.2 Insert New Rows
  • 7.2.2 Backup the Target Table Before Loading
    • 7.2.2.1 Drop Backup Table
    • 7.2.2.2 Create Backup Table
  • 7.2.3 Tracking Records for Regulatory Compliance
    • 7.2.3.1 Load Tracking Records

A SQL Structured Substitution API Reference

• A.1 SqlInsertStatement.getColumnList()
• A.2 SqlInsertStatement.getQuery()
• A.3 SqlQuery.getSubqueries ()
• A.4 SqlInsertStatement.getTargetTable ()
• A.5 SqlQuery.getFromList ()
• A.6 SqlQuery.getSelectList ()
• A.7 FromClause.getJoinTable ()
• A.8 FromClause.getSourceTables ()
• A.9 FromClause.getTableQuery ()
• A.10 ArrayExpression.getTemplate()
• A.11 ArrayExpression.getChildMap()

B Substitution API Reference

• B.1 Substitution Methods List
  • B.1.1 Global Methods
  • B.1.2 Journalizing Knowledge Modules
  • B.1.3 Loading Knowledge Modules
  • B.1.4 Check Knowledge Modules
  • B.1.5 Integration Knowledge Modules
  • B.1.6 Reverse-Engineering Knowledge Modules
  • B.1.7 Service Knowledge Modules
  • B.1.8 Actions
• B.2 Substitution Methods Reference
  • B.2.1 getAK() Method
  • B.2.2 getAKColList() Method
  • B.2.3 getAllTargetColList() Method
  • B.2.4 getCatalogName() Method
  • B.2.5 getCatalogNameDefaultPSchema() Method
  • B.2.6 getCK() Method
  • B.2.7 getColDefaultValue() Method
  • B.2.8 getColList() Method
  • B.2.9 getColumn() Method
  • B.2.10 getContext() Method
  • B.2.11 getDataSet() Method
  • B.2.12 getDataSetCount() Method
  • B.2.13 getDataType() Method
  • B.2.14 getFilter() Method
  • B.2.15 getFilterList() Method
  • B.2.16 getFK() Method
  • B.2.17 getFKColList() Method
  • B.2.18 getFlexFieldValue() Method
  • B.2.19 getFormattedName() Method
  • B.2.20 getFrom() Method
  • B.2.21 getGrpBy() Method
  • B.2.22 getGrpByList() Method
  • B.2.23 getHaving() Method
  • B.2.24 getHavingList() Method
  • B.2.25 getIndex() Method
  • B.2.26 getIndexColList() Method
  • B.2.27 getInfo() Method
  • B.2.28 getJDBCConnection() Method
    • B.2.28.1 getJDBCConnection("WORKREP")
  • B.2.29 getJDBCConnectionFromLSchema() Method
  • B.2.30 getJoin() Method
  • B.2.31 getJoinList() Method
  • B.2.32 getJrnFilter() Method
  • B.2.33 getJrnInfo() Method
  • B.2.34 getLoadPlanInstance() Method
  • B.2.35 getModel() Method
  • B.2.36 getNbInsert(), getNbUpdate(), getNbDelete(), getNbErrors() and getNbRows() Methods
  • B.2.37 getNewColComment() Method
  • B.2.38 getNewTableComment() Method
  • B.2.39 getNotNullCol() Method
  • B.2.40 getObjectName() Method
  • B.2.41 getObjectNameDefaultPSchema() Method
  • B.2.42 getObjectShortName() Method
  • B.2.43 getOdiGeneratedAccessName() Method
  • B.2.44 getOdiInstance() Method
  • B.2.45 getOggModelInfo() Method
  • B.2.46 getOggProcessInfo() Method
  • B.2.47 getOption() Method
  • B.2.48 getPackage() Method
  • B.2.49 getParentLoadPlanStepInstance() Method
  • B.2.50 getPK() Method
  • B.2.51 getPKColList() Method
    • B.2.51.1 getPop() Method
  • B.2.52 getPrevStepLog() Method
  • B.2.53 getQuotedString() Method
  • B.2.54 getSchemaName() Method
  • B.2.55 getSchemaNameDefaultPSchema() Method
  • B.2.56 getSession() Method
  • B.2.57 getSessionVarList() Method
  • B.2.58 getSrcColList() Method
  • B.2.59 getSrcTablesList() Method
  • B.2.60 getStep() Method
  • B.2.61 getSubscriberList() Method
  • B.2.62 getSysDate() Method
  • B.2.63 getTable() Method
  • B.2.64 getTargetColList() Method
  • B.2.65 getTableName() Method
  • B.2.66 getTargetTable() Method
  • B.2.67 getTemporaryIndex() Method
  • B.2.68 getTemporaryIndexColList() Method
  • B.2.69 getUser() Method
  • B.2.70 getVersion() Method
  • B.2.71 hasPK() Method
  • B.2.72 isColAttrChanged() Method
  • B.2.73 isVersionCompatible() Method
  • B.2.74 nextAK() Method
  • B.2.75 nextCond() Method
  • B.2.76 nextFK() Method
  • B.2.77 setNbInsert(), setNbUpdate(), setNbDelete(), setNbErrors() and setNbRows() Methods
  • B.2.78 setTableName() Method
  • B.2.79 setTaskName() Method

C SNP_REV Tables Reference

• C.1 SNP_REV_SUB_MODEL
• C.2 SNP_REV_TABLE
• C.3 SNP_REV_COL
• C.4 SNP_REV_KEY
• C.5 SNP_REV_KEY_COL
• C.6 SNP_REV_JOIN
• C.7 SNP_REV_JOIN_COL
• C.8 SNP_REV_COND