Beruflich Dokumente
Kultur Dokumente
Installation Guide
Release 12
Part No. B28680-02
December 2006
Contents
Introduction
Conventions .............................................................................................................................. 1-1
Product Support......................................................................................................................... 1-2
Troubleshooting................................................................................................................... 1-3
iii
Profile Options
Overview of Profile Options.................................................................................................... A-1
iv
Send Us Your Comments
Oracle Configurator Installation Guide , Release 12
Part No. B28680-02
Oracle welcomes customers' comments and suggestions on the quality and usefulness of this document.
Your feedback is important, and helps us to best meet your needs as a user of our products. For example:
If you find any errors or have any other suggestions for improvement, then please tell us your name, the
name of the company who has licensed our products, the title and part number of the documentation and
the chapter, section, and page number (if available).
Note: Before sending us your comments, you might like to check that you have the latest version of the
document and if any concerns are already addressed. To do this, access the new Applications Release
Online Documentation CD available on Oracle MetaLink and www.oracle.com. It contains the most
current Documentation Library plus all documents revised or released recently.
Send your comments to us using the electronic mail address: appsdoc_us@oracle.com
Please give your name, address, electronic mail address, and telephone number (optional).
If you need assistance with Oracle software, then please contact your support representative or Oracle
Support Services.
If you require training or instruction in using Oracle software, then please contact your Oracle local office
and inquire about our Oracle University offerings. A list of Oracle offices is available on our Web site at
www.oracle.com.
Preface
Intended Audience
Welcome to Release 12 of the Oracle Configurator Installation Guide .
This installation guide provides explanations and instructions for tasks required to
install the CZ schema, Oracle Configurator Developer, and a runtime Oracle
Configurator.
If you are responsible for installing Oracle Configurator, be sure you understand Oracle
Applications technology, terminology, and architecture before beginning the
installation. For details, see Oracle Applications Documentation Resources, Release 12,
Oracle MetaLink Document 394692.1.
This manual is intended for anyone installing or supporting the installation of Oracle
Configurator.
Ordinarily, the tasks presented in this book are performed by one of the following
people:
System Administrator (that is, an Oracle Applications user who is assigned to the
System Administrator responsibility)
This person is responsible for administering the Oracle Applications system,
including:
The System Administrator provides support for problems with the system. They
may perform setup and initial maintenance of the production system or advise their
vii
client's operational staff on these tasks. The System Administrator works with the
project team to optimize system performance, install packaged applications
environments, and convert data.
Database Administrator
Installs and configures the Oracle Applications database and maintains database
access controls. This person also provides consultation on performance and is
responsible for monitoring growth and fragmentation of the production database
and ensuring database backup and recovery.
See Related Information Sources on page ix for more Oracle Applications product
information.
Documentation Accessibility
Our goal is to make Oracle products, services, and supporting documentation
accessible, with good usability, to the disabled community. To that end, our
documentation includes features that make information available to users of assistive
technology. This documentation is available in HTML format, and contains markup to
facilitate access by the disabled community. Accessibility standards will continue to
evolve over time, and Oracle is actively engaged with other market-leading technology
vendors to address technical obstacles so that our documentation can be accessible to all
of our customers. For more information, visit the Oracle Accessibility Program Web site
at http://www.oracle.com/accessibility/ .
viii
Structure
1 Introduction
This chapter describes the conventions used in this guide, provides information about
troubleshooting issues with Oracle Configurator and Configurator Developer, and tells
you how to contact Oracle Support Services.
2 Installing Oracle Configurator
3 Upgrading to this Release
4 Oracle Configurator Servlet Considerations
5 Troubleshooting Servlet Installation
A Profile Options
Common Glossary for Oracle Configurator
Integration Repository
The Oracle Integration Repository is a compilation of information about the service
endpoints exposed by the Oracle E-Business Suite of applications. It provides a
complete catalog of Oracle E-Business Suite's business service interfaces. The tool lets
users easily discover and deploy the appropriate business service interface for
integration with any system, application, or business partner.
The Oracle Integration Repository is shipped as part of the E-Business Suite. As your
instance is patched, the repository is automatically updated with content appropriate
for the precise revisions of interfaces in your environment.
ix
Browser, database triggers, or any other tool to modify Oracle Applications data unless
otherwise instructed.
Oracle provides powerful tools you can use to create, store, change, retrieve, and
maintain information in an Oracle database. But if you use Oracle tools such as
SQL*Plus to modify Oracle Applications data, you risk destroying the integrity of your
data and you lose the ability to audit changes to your data.
Because Oracle Applications tables are interrelated, any change you make using an
Oracle Applications form can update many tables at once. But when you modify Oracle
Applications data using anything other than Oracle Applications, you may change a
row in one table without making corresponding changes in related tables. If your tables
get out of synchronization with each other, you risk retrieving erroneous information
and you risk unpredictable results throughout Oracle Applications.
When you use Oracle Applications to modify your data, Oracle Applications
automatically checks that your changes are valid. Oracle Applications also keeps track
of who changes information. If you enter information into database tables using
database tools, you may store invalid information. You also lose the ability to track who
has changed your information because SQL*Plus and other database tools do not keep a
record of changes.
1
Introduction
This chapter describes the conventions used in this guide, provides information about
troubleshooting issues with Oracle Configurator and Configurator Developer, and tells
you how to contact Oracle Support Services.
This chapter covers the following topics:
Conventions
Product Support
Conventions
In examples, an implied carriage return occurs at the end of each line, unless otherwise
noted. You must press the Return key at the end of a line of input.
The table below lists other conventions that are also used in this guide.
Convention
Meaning
.
.
...
Introduction 1-1
Convention
Meaning
boldface text
italics
[]
>
name()
&
Product Support
The mission of the Oracle Support Services organization is to help you resolve any
issues or questions that you have regarding Oracle Configurator Developer and Oracle
Configurator.
To report issues that are not mission-critical, submit a Technical Assistance Request
(TAR) using MetaLink, Oracle's technical support Web site, at:
Example
http://www.oracle.com/support/metalink/
Log into your MetaLink account and navigate to the Configurator TAR template:
1.
2.
3.
4.
5.
1.
2.
You can also find product-specific documentation and other useful information using
MetaLink.
For a complete listing of available Oracle Support Services and phone numbers, see:
Example
http://www.oracle.com/support/metalink
Troubleshooting
Oracle Configurator Developer and Oracle Configurator use the standard Oracle
Applications methods of logging to analyze and debug both development and runtime
issues. These methods include setting various profile options and Java system
properties to enable logging and specify the desired level of detail you want to record.
For more information about logging, see:
The Oracle Applications System Administrator's Guide for descriptions of the Oracle
Applications Manager UI screens that allow System Administrators to set up
logging profiles, review Java system properties, search for log messages, and so on.
The Oracle Applications Supportability Guide, which includes logging guidelines for
both System Administrators and developers, and related topics.
The Oracle Applications Framework Developer's Guide, which describes the logging
options that are available via the Diagnostics global link. This document is available
on MetaLink.
Introduction 1-3
2
Installing Oracle Configurator
This chapter covers the following topics:
Overview
Required Patches
Overview
Oracle Configurator consists of the following:
The CZ schema: A subschema within the Oracle Applications database that stores
configuration model data.
If you are installing Oracle Applications Release 12 for the first time, the CZ schema,
Oracle Configurator Developer, and the runtime Oracle Configurator are installed by
running Oracle Rapid Install. For details, see Oracle Rapid Install, page 2-2.
If you are upgrading an existing Oracle Configurator installation, see Upgrading to this
Release, page 3-1.
Review all Oracle Configurator and Configurator Developer profile options and, if
necessary, modify them for your installation.
See Overview of Profile Options, page A-1.
2.
Verify that Oracle Rapid Install has set up the server correctly (new installations
only).
See Verifying Apache and OC4J Setup, page 4-2.
3.
Define users in Oracle Applications and assign them to at least one of the
5.
Verify that Oracle Configurator and Oracle Configurator Developer were installed
successfully and are set up correctly.
See Test Your Oracle Configurator and Oracle Configurator Developer Installation,
page 2-3.
6.
If you are implementing Multiple Language Support (MLS), see Installation and
Setup Considerations for Multiple Language Support, page 2-4.
2.
From the Oracle E-Business Suite Home page, select one of the predefined Oracle
Configurator Developer responsibilities, and then select Oracle Configurator
Developer from the list of available applications.
3.
If your installation was successful, the Main area of the Repository appears.
If you receive an error, set the profile option FND: Diagnostics to Yes. When you
launch Configurator Developer again, the error message will contain more detailed
information to help you resolve the issue.
4.
5.
Build Model structure. For example, create Components, Features, Feature Options,
and so on.
6.
Navigate to the Rules area of the Workbench, and then define one or more rules.
7.
Generate logic for the Model. You do this from the General area of the Workbench.
8.
Navigate to the User Interface area of the Workbench, and then generate a User
Interface.
9.
Verify that you can unit test the configuration model by launching the User
Interface. To do this:
1.
From the Structure, Rules, or User Interface area of the Workbench, click Test
Model.
2.
Select User Interface, and then select the User Interface you want to test from
the list.
3.
Click Finish. If your system is set up correctly, the User Interface you selected
appears in a runtime Oracle Configurator window.
If you receive an error, contact Oracle Support Services. For details, see Product
Support, page 1-2.
2.
Choose View>Character Set and the specific character set you want to use.
3.
4.
In the option group for respecting document-specified fonts, choose the option that
uses your default font setting, and ignores the document-specified fonts.
Required Patches
After installing Oracle Applications, you must run adpatch to apply the latest patches
to your Oracle Applications Release 12 environment. For the latest required patches,
contact Oracle Support or go to MetaLink, Oracle's technical support Web site.
See Maintaining Oracle Applications for information about applying patches.
3
Upgrading to this Release
This chapter covers the following topics:
Introduction
Introduction
This chapter contains information Functional Companions and legacy User Interfaces
that you should consider when upgrading from a previous release of Oracle
Configurator.
If you are upgrading from a previous version of Oracle Configurator Release 12, run
adpatch to apply the latest patches to your Oracle Applications Release 12
environment. For the latest required patches, go to MetaLink, Oracle's technical support
Web site. See Maintaining Oracle Applications for information about applying these
patches.
For additional information about this release of Oracle Configurator and Oracle
Configurator Developer, see the current release or patch information for Oracle
Configurator on MetaLink.
Note: Upgrading to a new version of Oracle Configurator does not
prevent end users from restoring configurations that were saved using
a previous version of the software. Additionally, restoring such a saved
configuration does not adversely affect the configuration in any way;
however, additional selections may be required if the Model structure
or any rules have changed.
The runtime Oracle Configurator supports DHTML UIs, but you cannot generate a
new DHTML UI, or modify an existing DHTML UI, in the HTML-based version of
Oracle Configurator Developer.
To generate or maintain DHTML UIs, you must install the limited edition of
Configurator Developer on a client machine. This version of Configurator
Developer provides limited functionality: it can be used only to generate, edit, and
unit test DHTML UIs. For more information, see the current release or patch
information for Oracle Configurator on Metalink, Oracle's technical support Web
site.
After upgrading, you must use the HTML-based Configurator Developer to modify
the Model structure or any rules, define new rules, or generate a UI that is based on
the OA Framework. These tasks are described in the Oracle Configurator Developer
User's Guide.
To make any rule or Model structure changes available in a published DHTML UI,
perform the following:
1.
Use the HTML-based Configurator Developer to generate logic for the Model.
2.
Use the limited edition of Configurator Developer to refresh the DHTML UI, or
3.
Use the limited edition of Configurator Developer to unit test the DHTML UI
(optional).
4.
Use the HTML-based Configurator Developer to republish the Model and the
updated DHTML UI.
A Model can have both a DHTML UI and a UI that is generated in the HTML-based
Developer. The information in the preceding paragraphs also applies in this
scenario.
If you want to modify existing Functional Companions and use them with a generated
UI, then you must first migrate them to Configurator Extensions. A Configurator
Extension that has been migrated from a Functional Companion is supported in both
generated and DHTML UIs. For details about Configurator Extensions, see the Oracle
Configurator Extensions and Interface Object Developer's Guide and the Oracle Configurator
Developer User's Guide.
If you need to run the migration concurrent programs, you must perform the tasks
described in Setup for Migrating Functional Companions, page 3-9 and use the
instructions in the Oracle Configurator Implementation Guide to run either the Migrate
All Functional Companions or Migrate Functional Companions for a Single Model
concurrent program.
If you need to retain legacy DHTML UIs that include Functional Companions, and
do not need the added functionality provided by Configurator Extensions, see
Maintaining Functional Companions, page 3-12.
If you wish to keep using an existing Functional Companion that is not already
associated with a Model, you can do so by creating Configurator Extension
bindings for it, since you cannot use the migration concurrent programs on it. See
the current release or patch information for Oracle Configurator on MetaLink,
Oracle's technical support Web site.
The type of User Interface used by the Model with which the Functional
Companion is associated
Migration Needed?
Migration Result
No
Legacy (DHTML) or
generated in the
HTML-based version
of Configurator
Developer
No
n/aExisting
Functional
Companions still
operate.
Yes
Legacy (DHTML) or
generated in the
HTML-based version
of Configurator
Developer
Yes
Functional
Companions replaced
with Configurator
Extensions
You cannot migrate an individual Functional Companion Rule. You can migrate all
the Functional Companion Rules for a specified Model (and its referenced children),
or for all Models in the database.
The migration process creates, where appropriate, a binding between the specified
Functional Companion method and the corresponding configuration event. The
migration process also creates any argument bindings required by the event, and
sets the event scope for the bindings.
There are certain configuration events used by Configurator Extensions that do not
correspond with Functional Companion methods. Consequently, these events do
not appear in Migration of Functional Companion Methods to Configurator
Extension Event Bindings, page 3-6.
There are certain Functional Companion methods that cannot be migrated by the
concurrent programs, and require manual migration. These are included in
When Migrated
initialize
(IRuntimeNode,
String, String, int)
postCXInit
terminate()
preCXTerminate
autoConfigure()
onCommand (Rule ID +
_AC)
Functional Companion
Method
When Migrated
generateOutput
(HttpServletResponse
)
onCommand (Rule ID +
_GO)
validate()
onConfigValidate
validateEligibleTarg
et (Component)
onValidateEligibleT
arget
afterSave()
postConfigSave
onLoad()
onInstanceLoad
onNew()
postConfigNew
onRestore()
postConfigRestore
onSave()
preConfigSave
onSummary()
preConfigSummary
Functional Companion
Method
When Migrated
postLoad()
postInstanceLoad
postConfigInit
postInstanceAdd
postInstanceDelete
postInstanceEditable
postInstanceEditable
postInstanceNonEditable
postInstanceNameChange
postConnect
postDisconnect
postValueChange
preConfigCancel
preConfigDone
preConfigTerminate
There are a number of methods that might be used in Functional Companions that are
not migrated by the concurrent programs described in this section. These methods are
listed in Functional Companion Methods That Are Not Migrated, page 3-8.
Functional Companion Methods That Are Not Migrated
Method
Example
Functional Companion.generateOutput()
Method
Example
ICompSetEventListener.
notifyComponentAdded(Component)
Example
ICompSetEventListener.
notifyComponentDeleted(Component)
Example
IConfigEventListener.
notifyComponentAdded(Component)
Example
IConfigEventListener.
notifyComponentDeleted(Component)
Example
IConfigurationEventListener.
eventOccured(ConfiguationEvent)
Example
IConnectionEventListener.
notifyConnectionAssigned(Connector)
Example
IConnectionEventListener.
notifyConnectionUnassigned(Connector)
Example
IUserInterfaceEventListener.
handleUserInterfaceEvent(Event)
Before you run the concurrent programs to migrate Functional Companions, you
must put the Java classes that implemented the Functional Companions (which
might be in Java archive files in JAR or Zip format) into the class path of the
Concurrent Manager. Assuming as an example that your Java classes are in an Java
archive file named fc.jar, use the following procedure:
1.
The file fc.jar must be in a directory that is accessible from the computer on
which your Concurrent Manager is started. If it is not, then add the full class
path of fc.jar (including fc.jar) to the variable AF_CLASSPATH in the file
$APPL_TOP/admin/adovar.env.
2.
3.
Before you run the concurrent programs to migrate Functional Companions, you
must ensure that servlet.jar is in the system classpath.
After you run the concurrent programs to migrate Functional Companions, remove
the Java classes that implemented the Functional Companions from the class path of
your Web server. Then create Configurator Extension Archives for the Java classes,
as described in the Oracle Configurator Developer User's Guide. If you leave the Java
classes in the class path, the runtime Oracle Configurator will use those versions
instead of the versions in the Configurator Extension Archives.
Rewrite, compile, and archive the Java code so that it resembles the fragment in
Functional Companion Code After Manual Migration, page 3-11, which is
compatible with Configurator Extensions. For details, see the Oracle Configurator
Extensions and Interface Object Developer's Guide.
Functional Companion Code After Manual Migration
public class MyExtension { // no need to extend CIO classes
public void componentAdded(ComponentSet set, Component comp){ //
custom method
// do something
}
public void componentDeleted(ComponentSet set, Component comp){ //
custom method
// do something
}}
For details on the remaining steps, see the Oracle Configurator Developer User's Guide.
2.
3.
4.
In this Configurator Extension Rule, create an event binding for each method of
your Java class. The following table shows a choice of events that is appropriate to
the Java methods in the example. You must choose events that are appropriate to
your own case.
5.
Method Name
Event
Event Parameters
componentAdded(set,
comp)
postInstanceAdd
compSet
componentDeleted(set,
comp)
postInstanceDelete
instance
compSet
instance
For each binding, bind the arguments of the Java method to parameters that are
required for the event. The following table shows a choice of argument bindings
that is appropriate to both of the Java methods in the example. You must choose
bindings that are appropriate to your own case.
Argument Type
Argument Name
Argument
Specification
Binding
ComponentSet
set
Event Parameter
compSet
Component
comp
Event Parameter
instance
For a legacy Model that has been upgraded to this release, each unmigrated
Functional Companion is presented by default on a read-only page in the Rules
area of the Workbench Oracle Configurator Developer. This page enables you to
examine the definition of the Functional Companion rule. To migrate the Functional
Companion, you must run the Migrate Functional Companions for a Single Model
concurrent program, as described in Maintaining or Migrating Functional
Companions, page 3-3.
If you set the profile option CZ: Enable Creation of Functional Companions to Yes,
then each unmigrated Functional Companion is presented on a page in the Rules
area of the Workbench in Oracle Configurator Developer that enables you to edit its
definition. (For details about this profile option, see CZ: Enable Creation of
Functional Companions, page A-10.) Functional Companion rules have the same
attributes in this release as in the previous release: Name, Description, Type
(Validation, Auto-Configuration, Output, and Event-Driven), and Program String.
If you set the profile option to Yes, then you can also create new Functional
Companion rules, by clicking the Create icon in the Rules area of the
Workbench, then choosing Functional Companion. You should only create
such rules in an upgraded Model, to be included in a legacy DHTML UI. You
should not create Functional Companion rules in a generated UI created with
the HTML-based version of Oracle Configurator Developer.
See CZ: Enable Creation of Functional Companions, page A-10 for details
about the profile option that enables editing or creation of Functional
Companion rules.
4
Oracle Configurator Servlet Considerations
This chapter covers the following topics:
Introduction
Introduction
This chapter tells you how to verify that the Oracle Configurator Servlet (OC Servlet) is
set up correctly and describes all customizable OC Servlet properties.
To view a User Interface in a runtime Oracle Configurator, you must have the Oracle
Configurator Servlet (OC Servlet) installed on your internet server.
Installing the OC Servlet includes:
1.
2.
3.
Note: These instructions assume that you are installing on the Solaris
version of the latest version of JDK 1.5 for your platform. The
production version runs significantly faster than the reference version.
(Oracle Rapid Install provides JDK version 1.5.) See Verifying
oc4j.properties and cz_init.txt, page 4-3 for details on verifying this
setting.
The Oracle Configurator Installation Guide specific to the Oracle Configurator release
from which you recently upgraded.
For example, if you upgraded from release 11.5.8, refer to the release 11.5.8 version
of the Oracle Configurator Installation Guide.
Example
http://www.mysite.com:60/OA_HTML/configurator/UiServlet?test=version
The result should be the build and schema version of Oracle Configurator running on
the server. For example:
Example
Using configuration software build: 12.0.27.2
Expecting schema: 27b
If the build and schema version does not appear, refer to Oracle Application Server
documentation for details about troubleshooting server configuration.
You must log in as the owner of the configuration files in order to modify them.
you observe the rules for syntax. You may want to do this for testing purposes, to
observe which parameters are passed to the OC Servlet.
Note: The cz_init.txt file is intended only for properties that are
All OC4J properties are available as Java system properties and are available to both the
OC Servlet and all Oracle Configurator Java classes. By default, Oracle Rapid Install
places oc4j.properties and cz_init.txt in the following directory:
Example
/ins/apps/EnvName/ora/10.1.3/j2ee/oacore/config
The properties are set on the Java Virtual Machine (JVM) that runs the OC4J container
so they are available to the OC Servlet when it starts up.
Note: Oracle Containers for J2EE (OC4J) is the core J2EE runtime
Java Requirements
Verify that the JServ engine is using the production version (as opposed to the reference
version) of the JDK. For example:
Example
wrapper.bin=/local/java/jdk1.5p/bin/java
Note: If your operating system is HP-UX, you must use JDK version
1.2.2.08 or higher.
Oracle strongly recommends that you run Java 5 (JDK 1.5) or higher. Oracle Rapid
Install installs this version by default.
For details, see Syntax and Context for Setting Parameters, page 4-4.
Example
cz.uiservlet.pre_load_filename=init_msg.txt
See the Oracle Configurator Implementation Guide for information on Return URL servlets.
Note: The Java classes that implement the behavior of Configurator
must restart the OC Servlet to load the new class file. It is not necessary
to restart the OC Servlet when you modify Configurator Extensions,
because they are loaded from the database.
page 4-3.
The properties of the OC Servlet for which you can set Apache configuration
parameters are listed in Properties for the Oracle Configurator Servlet, page 4-6.
Properties for the Oracle Configurator Servlet
Property Name
Description
cz.uiserver.applet_client_pol
l_wait, page 4-6
cz.uiserver.check_heartbeat_
timeout, page 4-7
cz.uiserver.database_poll_ti
meout, page 4-8
cz.uiserver.heartbeat_interva
l, page 4-9
cz.uiserver.poll_timeout_app
let, page 4-9
cz.uiservlet.dio_share, page
4-9
cz.uiservlet.pre_load_filena
me, page 4-10
cz.uiservlet.versionfuncsavai
l, page 4-12
cz.uiserver.applet_client_poll_wait
If your operating system is Macintosh version 9x running mrj 2.2x and you have
implemented Secure Sockets Layer (SSL), this property sets the length of time that the
Applet session "sleeps" between polls to the server, allowing the client session (Web
browser) a free connection to the server. If your operating system is not the specific
Macintosh version listed above or you have not implemented SSL, the OC Servlet
ignores this property.
Background: In Macintosh version 9x, mrj 2.2x, legacy UIs (that is Java Applet and
DHTML) and User Interfaces generated in Configurator Developer do not maintain
separate connections when polling the server. This adversely affects the performance of
the UI and may even cause it to fail.
See The Heartbeat Mechanism and Guided Selling, page 4-7 for additional
information.
The suggested range is 5,000 to 30,000 milliseconds. The default value is 15,000
milliseconds.
Note: Setting this property to a small value (such as 5,000) may affect
Syntax:
Example
cz.uiserver.applet_client_poll_wait=milliseconds
Example
cz.uiserver.applet_client_poll_wait=20000
cz.uiserver.check_heartbeat_timeout
This property controls the timeout for the UI Server's checking of "heartbeat" events.
(See The Heartbeat Mechanism and Guided Selling, page 4-7 for a description of
heartbeat events.) If the UI Server doesn't receive any heartbeats from the Web browser
after this time value, then the UI Server will end the configuration session and send a
"terminate" message back to the Applet client. The default value for this property is
30,000 milliseconds.
Set this property to a value that is 3 times the value of
cz.uiserver.heartbeat_interval and cz.uiserver.poll_timeout (these
properties should have the same value). For example, if each of these properties are set
to 20000, then set cz.uiserver.check_heartbeat_timeout to 60000.
If loading a large configuration model, set this property to a value that is approximately
how long it takes to load the Model. For example, if the configuration model takes 60
seconds to load, set this property to approximately 60000 milliseconds.
Syntax:
Example
cz.uiserver.check_heartbeat_timeout=milliseconds
Example
cz.uiserver.check_heartbeat_timeout=60000
The client session (the Web browser) sends heartbeat events to a session that is
running in the UI Server. Continued heartbeats indicate that the client is still "alive".
A cessation of heartbeats indicate that the client has terminated. This cessation is
detected by the session that is running on the UI Server.
2.
The Applet client polls an Applet session running in the UI Server to check whether
the UI Server has received a termination message from the client session.
3.
If the frequency of heartbeats received by the client session are less than the amount
specified by cz.uiserver.heartbeat_interval, page 4-9, then the UI Server sends the
termination message to the Applet session, which is being polled by the Applet
client running under Order Management.
Heartbeat Mechanism Properties, page 4-8 lists the servlet properties that control the
operation of the heartbeat mechanism.
Heartbeat Mechanism Properties
Property
Page Reference
Example
cz.uiserver.check_heartbeat_timeout,
page 4-7
cz.uiserver.check_heartbeat_timeout, page
4-7
Example
cz.uiserver.heartbeat_interval, page 49
Example
cz.uiserver.poll_timeout_applet, page 49
cz.uiserver.heartbeat_interval, page
4-9
cz.uiserver.poll_timeout_applet,
page 4-9
The value for all of these heartbeat parameters must be greater than zero, and must be
less than the timeout value for the Web listener.
cz.uiserver.database_poll_timeout
This property specifies the amount of time that the server session waits before
contacting the database to indicate that the configuration session is still active (this is
known as "polling" the database). This system property is used only by HTML User
Interfaces (in other words, UIs created in Oracle Configurator Developer release 11.5.10
or later).
You may want to increase the default value if your environment has minimal system
resources (for example, few database connections), since doing so will cause the server
to contact the database less frequently, thereby reducing the possibility that the
configuration session will expire prematurely.
The default value is 5000 milliseconds (5 seconds).
Syntax:
Example
cz.uiserver.database_poll_timeout=value
Example
cz.uiserver.database_poll_timeout=15000
cz.uiserver.heartbeat_interval
This property controls the frequency at which the heartbeat is sent from the client
browser to the UI Server. The default value is 10000 milliseconds. The suggested range
for this property is between 10,000 and 60,000. This property and
cz.uiserver.poll_timeout_applet should be set to the same value.
See The Heartbeat Mechanism and Guided Selling, page 4-7 for background.
Syntax:
Example
cz.uiserver.heartbeat_interval=milliseconds
Example
cz.uiserver.heartbeat_interval=10000
cz.uiserver.poll_timeout_applet
This property sets the time after which the UI Server's Applet session tells the Applet
client to poll back, to check whether the UI Server session was terminated. The default
value is 10,000 milliseconds. The suggested range for this property is between 10,000
and 60,000. This property and cz.uiserver.heartbeat_interval should be set to
the same value.
See The Heartbeat Mechanism and Guided Selling, page 4-7 for background.
Syntax:
Example
cz.uiserver.poll_timeout_applet=milliseconds
Example
cz.uiserver.poll_timeout_applet=10000
cz.uiservlet.dio_share
This property controls whether the UI Server running inside the OC Servlet shares
configuration model data that is cached in the DIO between configuration sessions.
The default value of this property is true, which enables sharing of cached model data.
Sharing cached model data improves the loading performance of sessions after the first
one for a given configuration model, but requires that the OC Servlet be restarted for
the runtime Oracle Configurator to reflect recent changes to generated logic. However,
configuration sessions started with the Test Model button in Oracle Configurator
Developer always ignore the cached model data and fetch the latest data from the
database, thus reflecting changes to generated logic.
The default setting provides a convenience for Model developers while providing
efficiency for runtime users. As a general rule, you should not change the default value
(true).
Setting this property to false disables sharing of the cached Model for all
configuration sessions on the same OC Servlet. In other words, a value of false
counteracts the performance enhancement derived by preloading and caching
configuration model data. For more information, see cz.uiservlet.pre_load_filename,
page 4-10.
Syntax:
Example
cz.uiservlet.dio_share=[truefalse]
Example
cz.uiservlet.dio_share=true
For information about decaching configuration model data, see the Oracle Configurator
Performance Guide.
cz.uiservlet.pre_load_filename
Define this property in cz_init.txt if you want to improve performance when the
OC Servlet starts up by caching configuration model data. This property specifies an
absolute path to a file containing an initialization message for the OC Servlet, and this
file identifies the configuration model(s) to preload.
This property is not defined by default.
Syntax:
Example
cz.uiservlet.pre_load_filename=absolute_path_to_initialization_file
Example
cz.uiservlet.pre_load_filename=/home/apache/init_msg.txt
The contents of your initialization file must be a valid Oracle Configurator initialization
message, the construction of which is described in detail in the Oracle Configurator
Implementation Guide. Make sure that the initialization message appears on a single line
with no line breaks in the message text. There can be multiple initialization messages in
the file (that is, one message for each Model you want to preload), but each initialization
message must be on its own line.
The following is an example of an initialization message (each parameter appears on a
separate line here only to improve readability):
Example
<initialize>
<param name="database_id">dbc_filename</param>
<param name="gwyuid">applsyspub/pub</param>
<param name="user">apps</param>
<param name="pwd">apps</param>
<param name="ui_type">JRAD</param>
<param name="context_org_id">5</param>
<param name="model_id">1234</param>
<param name="calling_application_id">671</param>
</initialize>
To preload a servlet with Apache, you must also specify the servlet's class name as the
value of the parameter servlets.startup in the file zone.properties.
Example for setting servlets.startup:
Example
servlets.startup=oracle.apps.cz.servlet.UiServlet
servlets.startup=oracle.apps.cz.runtime.PreLoadServlet
servlets.startup=oracle.apps.cz.runtime.oa.FwkUiPreLoadServlet
The first line listed above enables preloading of legacy DHTML User Interfaces.
The second and third lines enables preloading of UIs created in Configurator Developer
release 11.5.10 and later. If you recently upgraded to this release of Oracle Configurator,
the first line appears in zone.properties by default. If you are installing Oracle
Configurator for the first time, none of the lines listed above appear in
zone.properties by default. In this case, you must enter the servlets.startup
parameter for the types of UIs you want to preload. For example, if you want to preload
both legacy DHTML UIs and HTML UIs, enter all three lines.
To verify that configuration model data is being preloaded:
1.
Enable logging.
2.
3.
4.
5.
Check the FND log files and verify that configuration model data is being
preloaded.
Note: Preloading configuration models improves runtime performance
For information about decaching configuration model data, see the Oracle Configurator
Performance Guide.
cz.uiservlet.versionfuncsavail
Use this property to determine whether the servlet responds to the test=version
message entered in a Web browser. The default value is true.
For details, see:
Syntax:
Example
cz.uiservlet.versionFuncsAvail=[truefalse]
Example
cz.uiservlet.versionFuncsAvail=true
5
Troubleshooting Servlet Installation
This chapter covers the following topics:
Introduction
Introduction
This chapter provides suggestions for resolving problems that may arise when
installing the Oracle Configurator Servlet. This installation is described in Oracle
Configurator Servlet Considerations, page 4-1.
Oracle Configurator Developer and Oracle Configurator use the standard Oracle
Applications methods of logging to analyze and debug both development and runtime
issues. These methods include setting various profile options and Java system
properties to enable logging and specify the desired level of detail you want to record.
For more information about logging, see:
Your executable path includes the Shared Object files (.so or .dll). A symptom of
this problem might be an error message starting with a line similar to the following:
Example
java.lang.UnsatisfiedLinkError: no czjni in shared library path
The test
Invoke the following URL in a Web browser:
Example
http://hostname:portnum/OA_HTML/configurator/UiServlet?test=version
where hostname is the name of your internet server and portnum is the port number
for your Web listener. If the servlet is installed correctly and running, it should produce
an HTML page that prints the current build version of Oracle Configurator and the
expected version for the CZ schema.
For example:
Example
http://www.mysite.com:8802/configurator/UiServlet?test=version
If the UI servlet is running and installed correctly, entering this URL should produce a
result similar to the following:
Example
Using configuration software build: 12.0.27.2
Expecting schema: 27b
determines whether you can test the response of the servlet using the
test=veresion string. For details, see cz.uiservlet.versionfuncsavail,
page 4-12.
Enable logging, or increase the level of detail that Configurator Developer records
by changing settings available by clicking the Diagnostics global link. Look in the
log file to see which classes it loads, and from which JAR files. There may be a
message indicating that some classes failed to load. It is probably the case that there
is a JAR file in the list that is not in the path specified or that there was an error in
specifying its name.
For details about the logging options that are available via the Diagnostics global
link, see the Oracle Application Framework Documentation Resources, Release 12
(MetaLink note 391554.1).
There may be a basic problem with your Apache configuration. Refer to Oracle
Application Server documentation for troubleshooting information.
The test
You can launch a generated User Interface from Oracle Configurator Developer by
clicking the Test Model button in the Structure, Rules, or User Interface area of the
Workbench. For more information, see the chapter on unit testing in the Oracle
Configurator Developer User's Guide.
Alternatively, you can test the behavior of the runtime Oracle Configurator by creating
a test page that substitutes for your host application.
To do this:
1.
Create an HTML test page that posts an initialization message to the UI Servlet.
See the chapter on session initialization in the Oracle Configurator Implementation
Guide for an explanation of the OC initialization message.
See Test Page for Invoking the JRAD Runtime Oracle Configurator, page 5-4, and
the Oracle Configurator Implementation Guide for examples of simple test pages.
Ensure that you have the necessary database connectivity, and that your UI Servlet
is installed and configured correctly.
For details, see Verifying Apache and OC4J Setup, page 4-2.
2.
A
Profile Options
This appendix covers the following topics:
User
User
Res
p
Apps
Site
Required?
Default Value
BOM:
Configurator URL
of UI Manager ,
page A-7
Required with
Order
Management, i
Store, TeleSales,
and SalesOnLine
(none)
Profile Option
User
User
Res
p
Apps
Site
Required?
Default Value
CZ: Auto-Expire
Discontinued IB
Trackable Items,
page A-8
Optional
Yes
CZ: Configurator
Install Base, page
A-9
Optional
oracle.apps.
cz.dio.config.O
racleInstalledB
ase
Required with
Oracle Bills of
Material
Item Catalog
Description
Optional
One level
CZ: Disable
Configurator
Extensions, page
A-10
Optional
No
Optional
No
Optional
No
Optional
No
Optional
One level
CZ: Fail BV if
Configuration
Changed, page A11
Required with
Order
Management
No
Profile Option
User
User
Res
p
Apps
Site
Required?
Default Value
CZ: Fail BV if
Input Quantities
Not Maintained,
page A-11
Required with
Order
Management
Yes
CZ: Generic
Configurator UI
Max Child Rows,
page A-11
Required
50
CZ: Generic
Configurator UI
Type, page A-12
Optional
Java Applet
CZ: Include
Unchanged Install
Base Items, page
A-12
Optional
Yes
Optional
No
CZ: Populate
Decimal Quantity
Flags, page A-14
Optional
No
CZ: Publication
Lookup Mode ,
page A-15
Optional
Production
CZ: Publication
Usage , page A16
Optional
Any Usage
Required with
Oracle Install
Base
No
Profile Option
User
User
Res
p
Apps
Site
Required?
Default Value
CZ: Skip
Validation
Procedure, page
A-17
Optional
(none)
CZ: Suppress
Baseline Errors,
page A-17
Required with
Oracle Install
Base
No
Optional
No
Required with i
Store or Quoting
Yes
User
User
Res
p
Apps
Site
Required?
Default Value
Required
Description
CZ: BOM
Structure Display
Method, page A8
Required
Description
CZ: Custom
Initialization
Parameters , page
A-9
Optional
(none)
CZ: Effectivity
Date Filter, page
A-10
Optional
All
CZ: Enable
Creation of
Functional
Companions,
page A-10
Optional
No
CZ: Non-BOM
Node Display
Name, page A-13
Required
Name
CZ: Non-BOM
Structure Display
Method, page A13
Required
Name
CZ: Number of
Table Rows
Displayed, page
A-13
Required
25
Profile Option
User
User
Res
p
Apps
Site
Required?
Default Value
CZ: Number of
Rows Displayed
in Hierarchical
Tables, page A-13
Optional
50
CZ: Require
Locking, page A16
Required
Yes
GMA: Default
Language, page
A-19
Required
US
Required to
display online
help
CZ:CONTENT
S (at
Application
level)
Profile Options
You must set a value for profile options followed by the word "required," no default is
supplied. Ordinary users can see profile options followed by the word "exposed," only
system administrators can see the rest. Further details follow the list, click an item to
find them.
BOM: Configurator URL of UI Manager
CZ: Auto-Expire Discontinued IB Trackable Items
CZ: BOM Node Display Name
CZ: BOM Structure Display Method
CZ: BOM Tree Expansion State
CZ: Configurator Install Base
CZ: Create Item Type Name Method
CZ: Custom Initialization Parameters
The person installing Oracle Applications supplies this URL when running Oracle
Rapid Install. Oracle Rapid Install uses this information as the default value for BOM:
Configurator URL of UI Manager.
If you recently upgraded to a new version of Oracle Configurator, verify that this
profile option is set correctly.
Note: Setting this profile option is not required if you are installing a
All URLs in your profile options should be specified with the URL format:
machine_name.domain:port_number; where machine_name is the name of the server
machine, domain is your domain name, and port_number is the port where your service
is running. The Apache server port is typically 880n. For example:
Example
http://appsmachine.appsdomain:8800/OA_HTML/configurator/UiServlet
Order, regardless of whether they have changed in Installed Base. Set this profile option
to No if you want only items that have changed to appear in the Quote or Sales Order.
Setting this profile option to No may improve runtime performance because a smaller
set of items is returned to the host application.
This profile option can be set at the Site level only.
Note: When the value of this profile option changes, you must restart
For more information about the integration between Oracle Installed Base and Oracle
Configurator, see the Oracle Telecommunications Service Ordering Process Guide.
for all:
Integer Features, Decimal Features and Text Features, regardless of whether they
have any user input value
If the value of this profile option is Yes, CZ Config Items are created for:
BOM Models, but only when any of the following are true:
Integer Features, Decimal Features and Text Features, only if they have user input
values
Instantiable Components, only if they have descendants that are selected or have
user inputs, or are the target of a Connector
CZ Config Items are never created for Totals or Resources when this profile option is set
to Yes.
Setting this option to Yes may improve performance when saving large configuration
models, or a configuration that has many initial BOM Model instances.
This profile option can be set at the Site level only.
Note: When the value of this profile option changes, you must restart
CZ: Populate Decimal Quantity Flags Profile Option, page A-15 describes the effect of
setting this profile option.
CZ: Populate Decimal Quantity Flags Profile Option
Value
Effect
No
Yes
This profile option affects the behavior of the Import and Import Refresh concurrent
programs. The internal name of this profile option is CZ_IMP_DECIMAL_QTY_FLAG.
See the Oracle Configurator Implementation Guide for details.
when the profile option's value changes, you must log out of Oracle
Applications before starting another configuration session if you want
the new value to be used at runtime.
External data dependencies such as the one described above exist, but you are able
to detect programmatically whether that external data has changed since a given
configuration was last validated. In this case, the value of the profile option should
be the name of a PL/SQL function that returns true only if the external data is
known to be unchanged.
If neither of these conditions apply, you should not provide a value for this profile
option. In this case, the batch validation process always performs a complete validation.
To enable this profile option, specify the name of your PL/SQL callback function, using
the following format:
Example
package_name.procedure_name
If this profile option is set to Yes, Oracle Configurator retracts all end user selections at
the same time before updating the configuration. Enabling this profile option may
improve performance in large Models when a user performs one of the operations listed
above. By default, this profile option is set to No and Oracle Configurator retracts each
selection separately before updating the configuration. For more information, see the
section on user requests in the Oracle Configurator Extensions and Interface Object
Developer's Guide.
This profile option can be set at the Site level only.
Note: When the value of this profile option changes, you must restart
Glossary
This glossary contains definitions relevant to working with Oracle Configurator.
A
Archive Path
The ordered sequence of Configurator Extension Archives for a Model that determines
which Java classes are loaded for Configurator Extensions and in what order.
B
base node
The node in a Model that is associated with a Configurator Extension Rule. Used to
determine the event scope for a Configruator Extension.
batch validation
A background process for validating selections in a configuration.
binding
Part of a Configurator Extension Rule that associates a specified event with a chosen
method of a Java class. See also event.
BOM item
The node imported into Oracle Configurator Developer that corresponds to an Oracle
Bills of Material item. Can be a BOM Model, BOM Option Class node, or BOM Standard
Item node.
BOM Model
A model that you import from Oracle Bills of Material into Oracle Configurator
Developer. When you import a BOM Model, effective dates, ATO (Assemble To Order)
rules, and other data are also imported into Configurator Developer. In Configurator
Developer, you can extend the structure of the BOM Model, but you cannot modify the
BOM Model itself or any of its attributes.
Glossary-1
Glossary-2
Glossary-3
limited to one configuration model that is loaded when the session is initialized.
configurator
The part of an application that provides custom configuration capabilities. Commonly,
a window that can be launched from a host application so end users can make
selections resulting in valid configurations. Compare Oracle Configurator.
Configurator Developer
See OCD.
Configurator Extension
An extension to the configuration model beyond what can be implemented in
Configurator Developer.
A type of configuration rule that associates a node, Java class, and event binding so that
the rule operates when an event occurs during a configuration session .
A Java class that provides methods that can be used to perform configuration actions.
Configurator Extension Archive
An object in the Repository that stores one or more compiled Java classes that
implement Configurator Extensions.
connectivity
The connection across components of a model that allows modeling such products as
networks and material processing systems.
Connector
The node in the model structure that enables an end user at runtime to connect the
Connector node's parent to a referenced Model.
Constraint Definition Language
See CDL
Container Model
A type of BOM Model that you import from Oracle Bills of Material into Oracle
Configurator Developer to create configuration models that support connectivity and
contain trackable components. Configurations created from Container Models can be
tracked and updated in Oracle Install Base
Contributes to
A relation used to create a specific type of Numeric Rule that accumulates a total value.
See also Total.
Glossary-4
Consumes from
A relation used to create a specific type of Numeric Rule that decrements a total value,
such as specifying the quantity of a Resource used.
count
The number or quantity of something, such as selected options. Compare instance.
CZ
The product shortname for Oracle Configurator in Oracle Applications.
CZ schema
The implementation version of the standard runtime Oracle Configurator
data-warehousing schema that manages data for the configuration model . The
implementation schema includes all the data required for the runtime system, as well as
specific tables used during the construction of the configurator.
D
default
In a configuration, the automatic selection of an option based on the preselection rules
or the selection of another option.
Defaults relation
An Oracle Configurator Developer Logic Rule relation that determines the logic state of
Features or Options in a default relation to other Features and Options. For example, if
A Defaults B, and you select A, B becomes Logic True (selected) if it is available (not
Logic False).
Design Chart
An Oracle Configurator Developer rule type for defining advanced Explicit
Compatibilities interactively in a table view.
E
element
Any entity within a model, such as Options, Totals, Resources, UI controls, and
components.
end user
The ultimate user of the runtime Oracle Configurator. The types of end users vary by
project but may include salespeople or distributors, administrative office staff,
marketing personnel, order entry personnel, product engineers, or customers directly
Glossary-5
Glossary-6
host application
An application within which Oracle Configurator is embedded as integrated
functionality, such as Order Management or iStore.
I
implementer
The person who uses Oracle Configurator Developer to build the model structure, rules,
and UI customizations that make up a runtime Oracle Configurator. Commonly also
responsible for enabling the integration of Oracle Configurator in a host application.
Implies relation
An Oracle Configurator Developer Logic Rule type that determines the logic state of
Features or Options in an implied relation to other Features and Options. For example,
if A Implies B, and you select A, B becomes Logic True. If you deselect A (set to User
False), there is no effect on B, meaning it could be User or Logic True, User or Logic
False, or Unknown. See Requires relation.
import server
A database instance that serves as a source of data for Oracle Configurator's Populate,
Refresh, Migrate, and Synchronization concurrent processes. The import server is
sometimes referred to as the remote server.
initialization message
The XML (Extensible Markup Language) message sent from a host application to the
Oracle Configurator Servlet, containing data needed to initialize the runtime Oracle
Configurator. See also termination message.
instance
A runtime occurrence of a component in a configuration that is determined by the
component node's Instance attribute specifying a minimum and maximum value. See
also instantiate. Compare count.
Also, the memory and processes of a database.
instantiate
To create an instance of something. Commonly, to create an instance of a component in
the runtime user interface of a configuration model.
item
A product or part of a product that is in inventory and can be delivered to customers.
Glossary-7
Item
A Model or part of a Model that is defined in the Item Master. Also data defined in
Oracle Inventory.
Item Master
Data stored to structure the Model. Data in the CZ schema Item Master is either entered
manually in Oracle Configurator Developer or imported from Oracle Applications or a
legacy system.
Item Type
Data used to classify the Items in the Item Master. Item Catalogs imported from Oracle
Inventory are Item Types in Oracle Configurator Developer.
L
listener
A class in the CIO that detects the occurrence of specified events in a configuration
session.
Logic Rule
An Oracle Configurator Developer rule type that expresses constraint among model
elements in terms of logic relationships. Logic Rules directly or indirectly set the logical
state (User or Logic True, User or Logic False, or Unknown) of Features and Options in
the Model.
There are four primary Logic Rule relations: Implies, Requires, Excludes, and Negates.
Each of these rules takes a list of Features or Options as operands. See also Implies
relation, Requires relation, Excludes relation, and Negates relation.
M
model
A generic term for data representing products. A model contains elements that
correspond to items. Elements may be components of other objects used to define
products. A configuration model is a specific kind of model whose elements can be
configured by accessing an Oracle Configurator window.
Model
The entire hierarchical "tree" view of all the data required for configurations, including
model structure, variables such as Resources and Totals, and elements in support of
intermediary rules. Includes both imported BOM Models and Models created in
Configurator Developer. May consist of BOM Option Classes and BOM Standard Items.
Glossary-8
model structure
Hierarchical "tree" view of data composed of elements (Models, Components, Features,
Options, BOM Models, BOM Option Class nodes, BOM Standard Item nodes,
Resources, and Totals). May include reusable components (References).
N
Negates relation
A type of Oracle Configurator Developer Logic Rule type that determines the logic state
of Features or Options in a negating relation to other Features and Options. For
example, if one option in the relationship is selected, the other option must be Logic
False (not selected). Similarly, if you deselect one option in the relationship, the other
option must be Logic True (selected). Compare Excludes relation.
node
The icon or location in a Model tree in Oracle Configurator Developer that represents a
Component, Feature, Option or variable (Total or Resource), Connector, Reference,
BOM Model, BOM Option Class node, or BOM Standard Item.
Numeric Rule
An Oracle Configurator Developer rule type that expresses constraint among model
elements in terms of numeric relationships. See also, Contributes to and Consumes from.
O
object
Entities in Oracle Configurator Developer, such as Models, Usages, Properties,
Effectivity Sets, UI Templates, and so on. See also element.
OCD
See Oracle Configurator Developer.
option
A logical selection made in the Model Debugger or a runtime Oracle Configurator by
the end user or a rule when configuring a component.
Option
An element of the Model. A choice for the value of an enumerated Feature.
Oracle Configurator
The product consisting of development tools and runtime applications such as the CZ
schema, Oracle Configurator Developer, and runtime Oracle Configurator. Also the
Glossary-9
Glossary-10
model, but each publication corresponds to only one Model and User Interface.
publishing
The process of creating a publication record in Oracle Configurator Developer, which
includes specifying applicability parameters to control runtime availability and running
an Oracle Applications concurrent process to copy data to a specific database.
R
reference
The ability to reuse an existing Model or Component within the structure of another
Model (for example, as a subassembly).
Reference
An Oracle Configurator Developer node type that denotes a reference to another Model.
Repository
Set of pages in Oracle Configurator Developer that contains areas for organizing and
maintaining Models and shared objects in a single location.
Requires relation
An Oracle Configurator Developer Logic Rule relationship that determines the logic
state of Features or Options in a requirement relation to other Features and Options. For
example, if A Requires B, and if you select A, B is set to Logic True (selected). Similarly,
if you deselect A, B is set to Logic False (deselected). See Implies relation.
Resource
A variable in the Model used to keep track of a quantity or supply, such as the amount
of memory in a computer. The value of a Resource can be positive or zero, and can have
an Initial Value setting. An error message appears at runtime when the value of a
Resource becomes negative, which indicates it has been over-consumed. Use Numeric
Rules to contribute to and consume from a Resource.
Also a specific node type in Oracle Configurator Developer. See also node.
rules
Also called business rules or configuration rules. In the context of Oracle Configurator
and CDL, a rule is not a business rule. Constraints applied among elements of the
product to ensure that defined relationships are preserved during configuration.
Elements of the product are Components, Features, and Options. Rules express logic,
numeric parameters, implicit compatibility, or explicit compatibility. Rules provide
preselection and validation capability in Oracle Configurator.
See also Comparison Rule, Compatibility Rule, Design Chart, Logic Rule and Numeric
Rule.
Glossary-11
runtime
The environment in which an implementer (tester), end user, or customer configures a
product whose model was developed in Oracle Configurator Developer. See also
configuration session.
S
Statement Rule
An Oracle Configurator Developer rule type defined by using the Oracle Configurator
Constraint Definition Language (text) rather than interactively assembling the rule's
elements.
T
termination message
The XML (Extensible Markup Language) message sent from the Oracle Configurator
Servlet to a host application after a configuration session, containing configuration
outputs. See also initialization message.
Total
A variable in the Model used to accumulate a numeric total, such as total price or total
weight.
Also a specific node type in Oracle Configurator Developer. See also node.
U
UI
See User Interface.
UI Templates
Templates available in Oracle Configurator Developer for specifying UI definitions.
Unknown
The logic state that is neither true nor false, but unknown at the time a configuration
session begins or when a Logic Rule is executed. This logic state is also referred to as
Available, especially when considered from the point of view of the runtime Oracle
Configurator end user.
user
The person using a product or system. Used to describe the person using Oracle
Configurator Developer tools and methods to build a runtime Oracle Configurator.
Compare end user.
Glossary-12
user interface
The visible part of the application, including menus, dialog boxes, and other on-screen
elements. The part of a system where the user interacts with the software. Not
necessarily generated in Oracle Configurator Developer. See also User Interface.
User Interface
The part of an Oracle Configurator implementation that provides the graphical views
necessary to create configurations interactively. A user interface is generated from the
model structure. It interacts with the model definition and the generated logic to give
end users access to customer requirements gathering, product selection, and any
extensions that may have been implemented. See also UI Templates.
V
validation
Tests that ensure that configured components will meet specific criteria set by an
enterprise, such as that the components can be ordered or manufactured.
W
Workbench
Set of pages in Oracle Configurator Developer for creating, editing, and working with
Repository objects such as Models and UI Templates.
Glossary-13
Index
A
adpatch
running, 2-6
Apache
configuration files
cz_init.txt, 4-3
oc4j.properties, 4-3
troubleshooting installation, 5-2
verifying setup, 4-2
Application Server
installing, 2-2
B
batch validation
profile option, A-11
BOM: Configurator URL of UI Manager
profile option, A-7
browser
requirements, 2-4
C
caching
Models, 4-11
configuration files
cz_init.txt, 4-3
configurations
restoring saved configurations
after upgrading, 3-1
Configurator Extensions
recommended over Functional Companions,
3-3
conventions
used in this guide, 1-1
cz_init.txt
configuration file, 4-3
setup, 4-3
CZ: Auto-Expire Discontinued IB Trackable
Items
profile option, A-8
CZ: BOM Node Display Name
profile option, A-8
CZ: BOM Structure Display Method
profile option, A-8
CZ: BOM Tree Expansion State
profile option, A-9
CZ: Configurator Install Base
profile option, A-9
CZ: Create Item Type Name Method
profile option, A-9
CZ: Custom Initialization Parameters
profile option, A-9
CZ: Disable Configurator Extensions
profile option, A-10
CZ: Effectivity Filter
profile option, A-10
CZ: Enable ATP
profile option, A-10
CZ: Enable Creation of Functional Companions
profile option, A-10
CZ: Enable List Prices
profile option, A-11
CZ: Enable Selling Prices
profile option, A-11
CZ: Fail BV if Configuration Changed
Index-1
Index-2
cz.uiserver.heartbeat_interval
definition, 4-9
cz.uiserver.poll_timeout_applet, 4-9
cz.uiservlet.dio_share
definition, 4-9
cz.uiservlet.pre_load_filename
definition, 4-10
cz.uiservlet.versionfuncsavail
definition, 4-12
CZ schema
overview, 2-1
D
debugging
log files, 5-1
decimal quantities
profile option, A-14
DHTML (legacy UIs)
related servlet properties, 4-2
DHTML User Interfaces
maintaining, 3-2
E
errors
CZ: Suppress Baseline Errors
profile option, A-17
troubleshooting, 5-1
F
Functional Companions
maintaining, 3-12
maintaining, 3-3
migrating, 3-3
profile option, A-10
replacing with Configurator Extensions, 3-3
Fusion Middleware
Oracle Application Server, 2-2
G
Generic Configurator UI Type
profile option, A-12
Generic Configurator User Interface
profile option, A-11
GMA: Default Language
profile option, A-19
green threads
definition, 4-4
Xss8m option, 4-4
guided buying or selling
support for user interface, 4-7
H
heap size
recommended maximum value, 4heartbeat mechanism
for interface management, 4-8
Help System Root
profile option, A-19
Hide Focus in Generic Configurator UI
profile option, A-12
I
installing
Oracle Configurator, 2-1
Oracle Configurator Developer, 2-1
iOracle Application Server
installing, 4-1
J
Java
green threads, 4-4
JDK
verifying version information, 4-4
recommended JDK version, 4-2
Xss8m option, 4-4
Java applet (legacy UIs)
related servlet properties, 4-2
JDK (Java Development Kit)
recommended version, 4-2
verifying version information, 4-4
L
languages
Multiple Language Support, 2-4
Languages
setting, 2-5
log files
troubleshooting errors, 5-1
O
oc4j
configuring setup parameters, 4-2
OC4J
verifying setup, 4-2
oc4j.properties file
verifying, 4-3
OC Servlet
allow test message property, 4-12
definition, 4-6
installing, 4-1
maintaining custom properties, 3-2
oc4j.properties and cz_init.txt, 4-3
properties
cz.uiserver.database_poll_timeout, 4-8
cz.uiserver.heartbeat_interval, 4-9
cz.uiserver.poll_timeout_applet, 4-9
cz.uiservlet.dio_share, 4-9
properties
cz.runtime.use_dedicated_jvm, 4cz.uiserver.applet_client_poll_wait, 4-6
cz.uiserver.check_heartbeat_timeout, 4-7
cz.uiservlet.pre_load_filename, 4-10
cz.uiservlet.versionfuncsavail, 4-12
online help
profile option, A-19
Oracle Applications
defining responsibilities, 2-3
defining users, 2-2
Oracle Application Server
installing, 2-2
Oracle Configurator
installing, 2-1
log files, 5-1
Index-3
servlet
See OC Servlet
upgrading, 3-1
Oracle Configurator Developer
installing, 2-1
log files, 5-1
testing installation, 2-3
Oracle Install Base
profile option, A-9, A-12
Oracle Rapid Install
installing the OC Servlet, 4-1
overview, 2-2
Maintained, A-11
CZ: Generic Configurator UI Max Child Rows,
A-11
CZ: Generic Configurator UI Type, A-12
CZ: Hide Focus in Generic Configurator UI,
A-12
CZ: Include Unchanged Install Base Items, A12
CZ: Non-BOM Node Display Name, A-13
CZ: Non-BOM Structure Display Method, A13
CZ: Number of Rows Displayed in
Hierarchical Tables, A-13
CZ: Number of Table Rows Displayed, A-13
CZ: Only Create CZ Config Items for Selected
Options, A-13
CZ: Populate Decimal Quantity Flags, A-14
CZ: Publication Lookup Mode, A-15
CZ: Publication Usage, A-16
CZ: Report All Baseline Conflicts, A-16
CZ: Require Locking, A-16
CZ: Skip Validation Procedure, A-17
CZ: Suppress Baseline Errors, A-17
CZ: Use Alternate Retraction Algorithm
Before Structure Changes, A-18
CZ: Use Generic Configurator UI, A-19
GMA: Default Language, A-19
Help System Root, A-19
P
parameters
configuring Apache and oc4j, 4-2
in oc4j.properties, 4-3
proper syntax, 4-4
patches
adpatch, 2-6
for Oracle Configurator, 2-6
for Oracle Configurator Developer, 2-6
performance
caching model, 4-10, 4-11
preloading servlet, 4-11
Preferences
Languages setting, 2-5
profile options
BOM: Configurator URL of UI Manager, A-7
CZ: Auto-Expire Discontinued IB Trackable
Items, A-8
CZ: BOM Node Display Name, A-8
CZ: BOM Structure Display Method, A-8
CZ: BOM Tree Expansion State, A-9
CZ: Configurator Install Base, A-9
CZ: Create Item Type Name Method, A-9
CZ: Custom Initialization Parameters, A-9
CZ: Disable Configurator Extensions, A-10
CZ: Effectivity Filter, A-10
CZ: Enable ATP, A-10
CZ: Enable Creation of Functional
Companions, A-10
CZ: Enable List Prices, A-11
CZ: Enable Selling Prices, A-11
CZ: Fail BV if Configuration Changed, A-11
CZ: Fail BV If Input Quantities Not
Index-4
R
Rapid Install
See Oracle Rapid Install
response
from UI Servlet, 5-2
responsibilities
defining, 2-3
restoring
configurations
after upgrading, 3-1
Return URL Servlets
required location, 4-5
runtime Oracle Configurator
definition, 2-1
testing installation, 2-3
saved configurations
restoring in new Oracle Configurator version,
3-1
servlet
See OC Servlet
support
getting help with Oracle Configurator, 1-2
T
testing
control for OC Servlet, 4-12
test message, 5-2
test page, 5-3
threads
green, 4-4
translations
Multiple Language Support, 2-4
troubleshooting
analyzing errors, 5-1
Oracle Configurator issues, 1-3
U
upgrading
Oracle Configurator, 3-1
User Interface
legacy Configurator UIs, 4-2
users
defining, 2-2
V
version
property that accepts or rejects test message,
4-12
recommended JDK version, 4-2
W
Web browser
requirements, 2-4
Web server
configuration files
parameters, 4-4
Index-5