2
Oracle UCM Architecture 2-1
2
Oracle UCM Architecture
This chapter describes the architecture of Oracle Universal Content Management Oracle UCM in the context of what you need to know before beginning a
customization project. To create a customization efficiently and effectively, you should have an understanding of how Oracle UCM works.
This chapter includes the following sections:
■
Section 2.1, Oracle UCM Directories and Files
■
Section 2.2, Resources
■
Section 2.3, Oracle Content Server Behavior
2.1 Oracle UCM Directories and Files
When you create custom components or dynamic server pages, you work primarily with files in the bin, config, components, resources, and weblayout directories. The
following sections describe these directories:
■
Section 2.1.1, Terminology for Oracle UCM Directories
■
Section 2.1.2, The bin Directory
■
Section 2.1.3, The config Directory
■
Section 2.1.4, The components Directory
■
Section 2.1.5, The resources Directory
■
Section 2.1.6, The weblayout Directory
Caution: Modifying the default variables in these files can cause
Oracle UCM to malfunction. For more information about configuration variables, see the Oracle Fusion Middleware Idoc Script
Reference Guide.
2-2 Oracle Fusion Middleware Developers Guide for Oracle Universal Content Management
2.1.1 Terminology for Oracle UCM Directories
Oracle UCM documentation uses the following terms when referring to variables in the directories associated with the Oracle UCM installation, configuration, and
deployment:
■
IdcHomeDir: This variable refers to the ucmidc directory in the ECM Oracle home where the Oracle UCM server media is located. The server media can run Oracle
Content Server, Oracle Inbound Refinery, or Oracle Universal Records Management. This is essentially a read-only directory. The default location is
ECM_ORACLE_HOMEucmidc. The variable portion of the default location can be changed, but the path cannot be changed at ucmidc.
■
DomainHome: The user-specified directory where an Oracle UCM server is deployed to run on an Oracle WebLogic Server application server. The
DomainHomeucmshort-product-idbin directory contains the intradoc.cfg file and executables. The default location for DomainHome is MW_HOMEuser_
projectsdomainsbase_domain, but you can change the path and domain name base_domain during the deployment of Oracle UCM to Oracle WebLogic Server.
■
short-product-id: An abbreviated name for the type of Oracle UCM server deployed to an Oracle WebLogic Server domain, and it is used as the context root default
HttpRelativeWebRoot configuration value. Possible values follow:
■
cs Oracle Content Server
■
ibr Oracle Inbound Refinery
■
urm Oracle Universal Records Management
■
IntradocDir: The root directory for configuration and data files specific to an Oracle Content Server instance that is part of an Oracle UCM application deployed to an
Oracle WebLogic Server domain. This Idoc Script variable is configured for one type of Oracle Content Server instance: Oracle Content Server cs, Oracle
Inbound Refinery ibr, or Oracle Universal Records Management urm. This directory can be located elsewhere, but the default location is
DomainHomeucmshort-product-id. The specified directory must be an absolute path to the instance directory, and it must be unique to a particular server or node.
The directory files include startup files intradoc.cfg and executables.
2.1.2 The bin Directory
The bin directory is the root directory for Oracle Content Server startup files. It contains the intradoc.cfg file and the executable files that run Oracle Content Server
services, applets, and utilities. It is located at DomainHomeucmshort-product-idbin, in which short-product-id specifies whether it is for Oracle Content Server, Oracle
Inbound Refinery, or Oracle Universal Records Management.
Oracle UCM Architecture 2-3
The intradoc.cfg file is used to define system variables for Oracle Content Server, including directory, Internet, and refinery settings. Several of these variables can be set
using the Oracle Content Server System Properties utility.
A typical intradoc.cfg file follows: ?cfg jcharset=Cp1252?
Oracle Content Server Directory Variables IntradocDir=C:oracleidcm1
WebBrowserPath=C:Program FilesInternet Exploreriexplore.exe CLASSPATH=COMPUTEDCLASSPATH;SHAREDDIRclassesjtds.jar
Additional Variables HTMLEditorPath=C:Program FilesWindows XPAccessorieswordpad.exe
JAVA_SERVICE_EXTRA_OPTIONS=-Xrs
2.1.3 The config Directory
The config directory stores global configuration information for Oracle Content Server. This directory can be located elsewhere, but the default location is
DomainHomeucmshort-product-idconfig.
Element Description
Executables Services
■
IdcServer
■
IdcServerNT
Applets
■
IntradocApp launches all Admin tools
Utilities
■
Batch Loader
■
Installer
■
IdcAnalyze
■
Component Wizard
■
System Properties
■
IdcCommand intradoc.cfg file
Configuration file that contains the settings for Oracle Content Server services, applets, and utilities.
Note: If Oracle Content Server is set up as an automatic service and
you attempt to start an Oracle Content Server service IdcServer or IdcServerNT from the command line, you will receive an error
message: The port could not be listened to and is already is use.
Element Description
config.cfg file Defines system configuration variables.
2-4 Oracle Fusion Middleware Developers Guide for Oracle Universal Content Management
The config.cfg file is used to define global variables for the Oracle Content Server system. Several of these variables can be set using the Oracle Content Server System
Properties utility or by modifying the variables on the Admin Server General Configuration page.
A typical config.cfg file follows: ?cfg jcharset=Cp1252?
Oracle Content Server System Properties IDC_Name=idcm1
SystemLocale=English-US InstanceMenuLabel=JeanWTestSystem
InstanceDescription=idcm1 SocketHostAddressSecurityFilter=127.0.0.1|10.10.1.14
Database Variables IsJdbc=true
JdbcDriver=com.internetcds.jdbc.tds.Driver JdbcConnectionString=jdbc:freetds:sqlserver:jwilsonnote:1433oracle1;charset=UTF
8;TDS=7.0 JdbcUser=sa
JdbcPassword=UADle+jRz7Fi8DVzTDaGUCwUaQgQjKOQQEtI0PAqA= JdbcPasswordEncoding=Intradoc
DatabasePreserveCase=0
Internet Variables HttpServerAddress=jwilsonnote
MailServer=mail.example.com SysAdminAddress=sysadminexample.com
SmtpPort=25 HttpRelativeWebRoot=oracle
CgiFileName=idcplg UseSSL=No
WebProxyAdminServer=true NtlmSecurityEnabled=No
UseNtlm=Yes
General Option Variables EnableDocumentHighlight=true
EnterpriseSearchAsDefault=0 IsDynamicConverterEnabled=0
IsJspServerEnabled=0 JspEnabledGroups=
IdcRefinery Variables Additional Variables
WebServer=iis UseAccounts=true
IdcAdminServerPort=4440 SearchIndexerEngineName=DATABASE
VIPApproval:isRepromptLogin=true Vdk4AppSignature=SF37-432B-222T-EE65-DKST
Vdk4AppName=INTRANET INTEGRATION GROUP IntradocServerPort=4444
Oracle UCM Architecture 2-5
2.1.4 The components Directory
The IntradocDirdatacomponents directory contains the files that Oracle Content Server uses to configure system components.
The following example file is a component.hda file that defines the configuration status for a component called help.
?hda version=11.1.1.2.0-dev idcprod1 091209T125156 jcharset=UTF8 encoding=utf-8?
Properties LocalData blDateFormat=Md{yy} {h:mm[:ss] {aa}[zzz]}tAmericaChicagomAM,PM
end ResultSet Components
2 name
location help
componentshelphelp.hda end
2.1.5 The resources Directory
The IdcHomeDirresources directory contains two directories: admin and core. The resourcescore directory contains files that Oracle Content Server uses to assemble
web pages.
Element Description
idcshort-product-id_ components.hda
Identifies components that have been added to the Oracle Content Server system and whether they are enabled or disabled. Example:
idccs_components.hda. component.hda
Identifies the configuration status for a component.
Element Description
config Holds base configuration files for Oracle Content Server.
idoc Holds IdocScript dynamichtml and dynamicdata definitions.
install Holds files used by the installer and related applications.
javascript Holds files which are processed by the publishing engine and end up in
the weblayout directory as raw javascript files. jspserver
Holds jspserver xml files. lang
Holds localized string definitions for Oracle Content Server. reports
Holds templates for Oracle Content Server reports. resources
Holds resource definitions queries, page resources, services, and other resource data for Oracle Content Server.
tables Holds IdocScript resource table definitions.
templates Holds templates for all Oracle Content Server pages except reports.
2-6 Oracle Fusion Middleware Developers Guide for Oracle Universal Content Management
The resourcesadmin directory contains the following resource types.
2.1.6 The weblayout Directory
The DomainHomeucmshort-product-idweblayout directory contains the files that are available to the web server for display on the various pages of the Oracle Content
Server web site.
2.2 Resources
