Browser version script Skip Headers

Oracle Configurator Implementation Guide
Release 12.1
Part Number E14322-03
Go to next page
Next

Oracle Configurator Implementation Guide

Contents

Title and Copyright Information

Send Us Your Comments

Preface

Introduction

Part 1 consists of chapters that present a baseline for understanding Oracle Configurator.

Implementation Tasks

Overview
General Implementation Tasks
Database Tasks
      Required Database Tasks
      Optional Database Tasks
Integration Tasks
      Required Tasks for All Integrations
      Optional Integration Tasks
      Tasks for Custom Integration
Model Development Tasks
      Required Tasks for Model Development
      Optional Tasks for Model Development
Deployment Tasks
      Required Tasks for All Deployments
      Optional Tasks for Deployment
      Tasks for Custom Deployments
Conventions
Product Support
      Troubleshooting

Configurator Architecture

Overview
Introduction
Runtime Oracle Configurator
      Access
      Type of Host Application
      Login to Host Application
      Invocation of Oracle Configurator by Host Application
      Incorporation of Oracle Configurator in the Host Application’s UI
      Oracle Configurator Security on Publicly Accessible Web Servers
      Runtime UI Types
      Oracle Configurator Servlet
      UI Server
      Configuration Interface Object (CIO)
      Oracle Configurator Engine
Oracle CZ Schema
Oracle Configurator Developer
      Access
      Types of Configuration Models
      Unit Testing
Multi-Tier Architecture
      Runtime Oracle Configurator
      Oracle Configurator Developer Three Tiers

Database Instances

Overview
Database Uses
Multiple Database Instances
      Model Availability on Multiple Database Instances
      Import Source and Target
      Publication Source and Target
      Decommissioning a Database Instance
      Migration Source and Target
      BOM Synchronization Source and Target
      Linking Multiple Database Instances
      Instance and Host System Names
Model Development
Maintenance
Production
      System Testing
      Deploying a Model
      Converting a Publication Target Instance to a Development Instance

Data

Part 2 presents information about working with the CZ schema as described in Database Tasks.

The CZ Schema

Overview
Characteristics of the Oracle CZ Schema
      Online Tables and Integration Tables
      CZ Subschemas
      Public Synonyms
      Schema Customization
Import Tables
      Import Control Fields
      Online Data Fields
      Surrogate Key Fields
      Dependencies Among Import Tables
Control Tables
CZ_DB_SETTINGS Table
      Accessing the CZ_DB_SETTINGS Table
      Organization of the CZ_DB_SETTINGS Table
      CZ_DB_SETTINGS Parameters
      AltBatchValidateURL
      BadItemPropertyValue
      BatchSize
      BOM_REVISION
      CommitSize
      DISPLAY_INSTANCE_NAME
      FREEZE_REVISION
      GenerateGatedCombo
      GenerateUpdatedOnly
      GenStatisticsBOM
      GenStatisticsCZ
      MAJOR_VERSION
      MaximumErrors
      MemoryBulkSize
      MINOR_VERSION
      MULTISESSION
      OracleSequenceIncr
      PsNodeName
      PublicationLocalBOMSynch
      PublicationLogging
      PublishingCopyRules
      PurgeDeleteConfigBatchsize
      RefPartNbr
      ResolvePropertyDataType
      RestoredConfigDefaultModelLookupDate
      Revision Date and User
      RUN_BILL_EXPLODER
      SuppressSuccessMessage
      TimeImport
      UI_NODE_NAME_CONCAT_CHARS
      UseLocalTableInExtractionViews
      UtlHttpTransferTimeout

Populating the CZ Schema

Overview
Introduction
      Types of Data Stored in the CZ Schema During Development and Runtime
      Means of Populating the CZ Schema
      CZ_IMP Tables
Standard Import
      Inventory and BOM Data That Can Be Imported
      Overall Standard Import Procedure
      Determining the Import Data Source Instance and the Target Instance
      Preparing the Data for Import
      Defining Inventory Items for Configuration
      Creating BOM Models for Configuration
      Defining and Enabling a Server for Import
      Exploding BOM Models in Oracle Applications
      Exploding a BOM Model in Release 12
      Exploding a BOM Model in Release 10.7 or 11.0
      Controlling the Data for Import
      Importing Data Into Specific Tables
      Importing Data from Specific Fields
      Populating Import Tables
      Modifying EXPLOSION_TYPE
      Identifying a BOM Model for Import
      Importing Decimal or Integer Quantities
      Importing Minimum and Maximum Instances
      Importing the Data
      Verifying the Data Import
      Refreshing Imported Data
      Refreshing Imported Data Recommendations
      Refreshing Procedures
      Importing a BOM Model that Contains Other BOM Models
      Refreshing a BOM Model that Contains Other BOM Models
      BOM Model References Have Changed
      BOM Models Referenced by Previously Imported BOM Model Have Changed
      BOM Model with a Common Bill
Rule Import
      Populating CZ_IMP_RULES
      Populating CZ_IMP_LOCALIZED_TEXTS
      Rule Import Tables
      Stages of Rule Import
      Rule Validation
Rule Import Procedure
Custom Import
      Overview of Custom Data Import
      Identifying Data for a Custom Data Import
      Required ASCII File Format for Custom Import
      Loading Property Values by Type
Custom Import Procedure

Migrating Data

Introduction
Migrating Data from a CZ Schema
Migrating Models
      Migrating Referenced Models
      Restoring Saved Configurations of Migrated Models
      Synchronizing Migrated Model Data
      Synchronization Criteria During Model Migration

Synchronizing Data

Overview
Introduction
Synchronizing BOM Model Data
      The BOM Model Synchronization Process
      Checking BOM and Model Similarity
      Criteria for BOM Model Similarity
      Result of Synchronizing BOM Models
Synchronizing Publication Data
      Synchronizing Publication Data after a Database Instance is Cloned
      Example of Synchronizing Publication Data
      CZ_SERVERS Table
      CZ_MODEL_PUBLICATIONS Table
      Example Publication Data Before Cloning
      Example of Synchronizing Publication Data on a Cloned Target
      Example of Synchronizing Publication Data on a Cloned Source

CZ Schema Maintenance

Overview
Introduction
Refreshing or Updating the Production CZ Schema
Purging Configurator Tables
      Purge Configurator Tables
      Purge Configurator Import Tables
      Purge To Date Configurator Import Tables
      Purge To Run ID Configurator Import Tables
Redoing Sequences

Integration

Part 3 presents integration information for setting up Oracle Configurator with other Oracle Applications or a custom application as described in Integration Tasks.

Session Initialization

Overview
Introduction
      Definition of Session Initialization
      Responsibilities of the Host Application
Setting Parameters
      Parameter Syntax
      Omitting Parameters or Values
      Typical Parameter Values
      Minimal Test of Initialization
      Parameter Validation
      Logging of Parameter Use
Initialization Parameter Types
      Login Parameters
      Model Identification Parameters
      Identifying the User Interface Definition
      Identifying the Configuration
      Identifying the Model
      Model Publication Identification Parameters
      Support of Multiple Instantiation
      Return URL Parameter
      Pricing Parameters
      ATP Parameters
      Arbitrary Parameters
      Parameter Compatibility
Initialization Parameter Descriptions

Session Termination

Introduction
Overview
      Relationship to Initialization Message
      Definition of Session Termination
XML Message Structure
Submission
      Configuration Status
      Subelements for Configuration Status
      Configuration Outputs
      Subelements for Configuration Outputs
      Configuration Messages
      Subelements for Configuration Messages
Cancellation
Error
The Return URL
      Specifying the Return URL
      Implementing the Return URL

Batch Validation

Overview
Introduction
Passing the Batch Validation Message
Calling the CZ_CF_API.VALIDATE Procedure
Batch Validation Failure
Skipping Batch Validation
      PL/SQL Callback
      PL/SQL Callback and Models that use Configurator Extensions

Custom Integration

Overview
General Directory Structure
Files for the Servlet Directory
Files for the HTML Directory
Files for the Media Directory

Pricing and ATP in Oracle Configurator

Overview
Introduction
Runtime Oracle Configurator Pricing Architecture
      Pricing Callback Interface Package
      Pricing Callback Interface
      Use of the Database in the Price Multiple Items Procedures
      Examples of the Pricing Callback Interface
      ATP Callback Interface
      Use of the Database with the ATP Callback Interface
      Examples of the ATP Callback Interface
Runtime Pricing Behavior
Integration of Pricing and ATP with Oracle Configurator
      Database Compatibility
      Initialization Parameters
Controlling Pricing and ATP in a Runtime Oracle Configurator
      Displaying Prices and ATP Information
      Updating Prices
      Examples of Controlling Pricing
      Example: List Prices Only
      Example: Selling Prices Only

Multiple Language Support

Overview
Introduction
Data Import
      New Models
      Existing Models
Installed Languages in Multiple Server Environments
Deploying a User Interface that Supports MLS
Translating Data in CZ_LOCALIZED_TEXTS
Translating XML Documents

Configuration Model

This Part presents information that enables you to extend a BOM Model’s structure, rules, and UI to reflect your business requirements and integrate with a host application as described in Model Development Tasks.

Controlling the Development Environment

Overview
Setting up Oracle Configurator Developer
Setting up Access to Configurator Developer
Oracle Configurator Developer
      Model Development
      Runtime Testing

Publishing Configuration Models

Overview
Planning Publications
      Designing A Project
      Preventing Publication Access Errors
How Host Applications Select a Published Model
      Example: How a Usage Affects Model Structure, Rules, and Model Publications at Runtime
Defining a Publication
      Source and Remote Publications
      Tables Used in Publishing
      Publication Details
      Model
      Product ID
      User Interface
      Target Database Instance
      Mode
      Publication Applicability Parameters
      Applications
      Languages
      Usages
      Date Range
Publishing a Configuration Model
      Publication Profile Options
      Publishing and Model References
      Copying User Interface Data
      Copying Model Rules
      Checking BOM Model and Configuration Model Similarity
Maintaining Publications
      Publication Status
      Editing Publications
      Disabling, Deleting, and Re-enabling Publications
      Republishing
      Determining Publishing Information
      Retrieving Orders from Previously Published Models
      Synchronizing Publication Data
      Example of Maintaining Publications

Programmatic Tools for Development

Overview
Overview of the CZ_CF_API and CZ_CONFIG_API_PUB Packages
      Purpose of the Packages
      Overview of Procedures and Functions
      Installation of the Packages
      References for Working with PL/SQL Procedures and Functions
Choosing the Right Tool for the Job
      Establishing Session Identity
      Setting Configuration Dates
      Validating Configurations
      Verifying Configurations
      Copying and Deleting Configurations
      Working with Common Bills
      Identifying Publications
      Functions for Identifying Publications
      Applicability Parameters
      List Parameters
      Routing Models to Specified JVMs
Reference for the CZ_CF_API and the CZ_CONFIG_API_PUB Packages
      Custom Data Types
      Procedures and Functions in the CZ_CF_API and CZ_CONFIG_API_PUB Packages
COMMON_BILL_FOR_ITEM
      Syntax and Parameters
CONFIG_MODEL_FOR_ITEM
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
CONFIG_MODELS_FOR_ITEMS
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
CONFIG_MODEL_FOR_PRODUCT
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
CONFIG_MODELS_FOR_PRODUCTS
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
CONFIG_UI_FOR_ITEM
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
CONFIG_UI_FOR_ITEM_LF
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
CONFIG_UI_FOR_PRODUCT
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
CONFIG_UIS_FOR_ITEMS
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
CONFIG_UIS_FOR_PRODUCTS
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
COPY_CONFIGURATION
      Considerations Before Running
      Prerequisites
      Timing
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
      Troubleshooting
CZ_CONFIG_API_PUB.COPY_CONFIGURATION
      Considerations Before Running
      Prerequisites
      Timing
      Warnings
      Syntax and Parameters
COPY_CONFIGURATION_AUTO
      Considerations Before Running
      Prerequisites
      Timing
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
      Troubleshooting
CZ_CONFIG_API_PUB.COPY_CONFIGURATION_AUTO
      Considerations Before Running
      Prerequisites
      Timing
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
      Troubleshooting
DEFAULT_NEW_CFG_DATES
      Considerations Before Running
      Prerequisites
      Timing
      Dependencies
      Restrictions and Limitations
      Syntax and Parameters
      Considerations After Running
      Results
DEFAULT_RESTORED_CFG_DATES
      Considerations Before Running
      Prerequisites
      Timing
      Dependencies
      Restrictions and Limitations
      Syntax and Parameters
      Considerations After Running
      Results
DELETE_CONFIGURATION
      Considerations Before Running
      Prerequisites
      Timing
      Warnings
      Syntax and Parameters
      Considerations After Running
      Troubleshooting
ICX_SESSION_TICKET
      Considerations Before Running
      Prerequisites
      Timing
      Syntax and Parameters
      Considerations After Running
      Results
      Troubleshooting
MODEL_FOR_ITEM
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
      Considerations After Running
      Results
MODEL_FOR_PUBLICATION_ID
      Considerations Before Running
      Timing
      Dependencies
      Syntax and Parameters
POOL_TOKEN_FOR_PRODUCT_KEY
      Considerations Before Running
      Timing
      Dependencies
      Syntax and Parameters
PUBLICATION_FOR_ITEM
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
PUBLICATION_FOR_PRODUCT
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
PUBLICATION_FOR_SAVED_CONFIG
      Considerations Before Running
      Timing
      Dependencies
      Warnings
      Syntax and Parameters
REGISTER_MODEL_TO_POOL
      Considerations Before Running
      Timing
      Dependencies
      Syntax and Parameters
UNREGISTER_MODEL_FROM_POOL
      Considerations Before Running
      Timing
      Dependencies
      Syntax and Parameters
UNREGISTER_POOL
      Considerations Before Running
      Timing
      Dependencies
      Syntax and Parameters
UI_FOR_ITEM
      Considerations Before Running
      Timing
      Dependencies
      Syntax and Parameters
      Considerations After Running
      Results
UI_FOR_PUBLICATION_ID
      Considerations Before Running
      Timing
      Dependencies
      Syntax and Parameters
      Example
VALIDATE
      Considerations Before Running
      Syntax and Parameters
      Example
      Considerations After Running
      Results
CZ_CONFIG_API_PUB.VERIFY_CONFIGURATION
      Considerations Before Running
      Timing
      Dependencies
      Syntax and Parameters

Programmatic Tools for Maintenance

Overview
Overview of the CZ_modelOperations_pub Package
      Purpose of the Package
      Installation of the Package
      References for Working with PL/SQL Procedures and Functions
Choosing the Right Tool for the Job
Queries to Support the CZ_modelOperations_pub Package
      Querying for Model and Folder IDs
      Querying for User Interface IDs
      Querying for Referenced User Interface IDs
      Querying for Populators
      Querying for Error and Warning Information
Reference for the CZ_modelOperations_pub Package
      Custom Data Types
      API Version Numbers
      Format of API Version Numbers
      Current API Version Number for This Package
      Checking for Incompatible API Calls
      Procedures and Functions in the CZ_modelOperations_pub Package
CREATE_RP_FOLDER
      Considerations Before Running
      Alternatives
      Syntax and Parameters
CREATE_UI
      Considerations Before Running
      Alternatives
      Syntax and Parameters
CREATE_JRAD_UI
      Considerations Before Running
      Alternatives
      Syntax and Parameters
DEEP_MODEL_COPY
      Considerations Before Running
      Alternatives
      Syntax and Parameters
EXECUTE_POPULATOR
      Considerations Before Running
      Alternatives
      Syntax and Parameters
FORCE_UNLOCK_MODEL
      Considerations Before Running
      Alternatives
      Syntax and Parameters
FORCE_UNLOCK_TEMPLATE
      Considerations Before Running
      Alternatives
      Syntax and Parameters
GENERATE_LOGIC
      Considerations Before Running
      Alternatives
      Syntax and Parameters
      Example
IMPORT_SINGLE_BILL
      Considerations Before Running
      Alternatives
      Syntax and Parameters
IMPORT_GENERIC
      Considerations Before Running
      Alternatives
      Syntax and Parameters
PUBLISH_MODEL
      Considerations Before Running
      Restrictions and Limitations
      Alternatives
      Syntax and Parameters
MIGRATE_MODELS
      Considerations Before Running
      Restrictions and Limitations
      Alternatives
      Syntax and Parameters
REFRESH_SINGLE_MODEL
      Considerations Before Running
      Syntax and Parameters
REFRESH_UI
      Considerations Before Running
      Restrictions and Limitations
      Alternatives
      Syntax and Parameters
REFRESH_JRAD_UI
      Considerations Before Running
      Alternatives
      Syntax and Parameters
REPOPULATE
      Considerations Before Running
      Alternatives
      Syntax and Parameters
REPUBLISH_MODEL
      Considerations Before Running
      Alternatives
      Syntax and Parameters
RP_FOLDER_EXISTS
      Considerations Before Running
      Alternatives
      Syntax and Parameters

Runtime Configurator

This Part presents information for deploying a runtime Oracle Configurator that is embedded in a host Oracle Application or a custom host application as described in Deployment Tasks.

User Interface Deployment

Overview
Calling an Embedded Oracle Configurator
      Generic Configurator User Interfaces
      Criteria for Launching a Generic Configurator User Interface
      Generic Configurator UI Types
      Setting Up a Generic Configurator User Interface
      Generic Configurator User Interfaces: Additional Features and Limitations
      Keyboard Access in the Runtime Configurator

Deployment Considerations

Overview
Deployment Strategies
Architectural Considerations
Server Considerations
      Connection Pooling
Establishing End User Access
Determining the Runtime User Interface
Load Balancing and Secure Sockets Layer
Network Considerations
      Firewalls and Timeouts
      Router Timeouts
      Miscellaneous Issues
Security Considerations
      Internet User Access
      Additional Security Precautions
Multiple Language Support Considerations
Performance Considerations
Routing Models to Specified JVMs

Managing Configurations

Overview
About Configurations
      Saving a Configuration
      Restoring Saved Configurations
Configuration Identity
Host Applications and Oracle Configurator
Batch Validation of a Configured Item
Reconfiguring a Configured Item
Copying a Host Application’s Entity
Passing a Saved Configuration to Another Host Application
Deleting a Host Application Entity

Terminology

Overview

Common Tasks

Overview
Running Configurator Concurrent Programs
Connecting to a Database Instance
Verifying CZ Schema Version
Server Administration
Viewing the Status of Configurator Concurrent Requests
Viewing Log Files
Managing Oracle Configurator Caching
Checking BOM Model and Configuration Model Similarity

Concurrent Programs

Overview
Configurator Administration Concurrent Programs
      View Configurator Parameters
      Modify Configurator Parameters
      Purge Configurator Tables
      Purge Configurator Import Tables
      Purge To Date Configurator Import Tables
      Purge To Run ID Configurator Import Tables
Convert Publication Target Instance to Development Instance
Server Administration Concurrent Programs
      Add Application to Publication Applicability List
      Define Remote Server
      Enable Remote Server
      View Servers
      Modify Server Definition
Configuration Model Publication Concurrent Programs
      Process Pending Publications
      Process a Single Publication
Populate and Refresh Configuration Models Concurrent Programs
      Populate Configuration Models
      Populate Configuration Models Concurrent Program Error Messages
      Refresh a Single Configuration Model
      Refresh All Imported Configuration Models
      Disable/Enable Refresh of a Configuration Model
      Import Configuration Rules
Model Synchronization Concurrent Programs
      Check Model/Bill Similarity
      Check All Models/Bills Similarity
      Synchronize All Models
      Model/Bill Similarity Check Report
Execute Populators in Model
Migration Concurrent Programs
      Setup Configurator Data Migration
      Migrate Configurator Data
Migrate Functional Companions
      Migrate All Functional Companions
      Migrate Functional Companions for a Single Model
Model Management
      Add Model Node Names to Configurations by Model Items
      Add Model Node Names to Configurations by Model Product Key
      Migrate Models
Publication Synchronization Concurrent Programs
      Synchronize Cloned Target Data
      Synchronize Cloned Source Data
      Select Tables to be Imported
      Show Tables to be Imported

CZ Subschemas

Oracle Configurator Subschemas
      ADMN Administrative Tables
      CNFG Configuration Tables
      ITEM Item-Master Tables
      LCE Logic for Configuration Tables
      PB Publication Tables
      PRC Pricing Tables
      PROJ Project Structure Tables
      RP Repository Tables
      RULE Rule Tables
      TXT - Text Tables
      TYP - Data Typing
      UI User Interface Tables
      XFR Transfer Specifications and Control Tables

Code Examples

Overview
Pricing and ATP Callback Procedures
Implementing a Return URL Servlet

Common Glossary for Oracle Configurator

Index