2.1 Content Server Directories and Files

When you create custom components or dynamic server pages, you work primarily with files in certain directories. This section includes the following topics:

2.1.1 Terminology for UCM Directories

UCM documentation uses the following terms when referring to variables in the directories associated with the UCM install configuration and deployment:

  • IdcHomeDir: The variable for the directory in $ORACLE_HOME where the Oracle UCM (ucm) server media is located. The server media can run Content Server, Inbound Refinery, or Universal Records Management.

  • DomainHome: The variable for the user-specified directory where the Oracle UCM server is deployed to run inside the Oracle WebLogic Server application server. The DomainHome/ucm/short-product-id/bin directory contains the intradoc.cfg file and executables.

  • short-product-id: An abbreviated name for the type of Oracle UCM server deployed on an Oracle WebLogic Server, used as the context root (default HttpRelativeWebRoot configuration value). Possible values are:

    • cs—Content Server

    • ibr—Inbound Refinery

    • urm—Records Manager

  • IntradocDir: The variable for the root directory for configuration and data files specific to a Content Server instance. The default location for this directory is DomainHome/ucm/short-product-id.

2.1.2 bin Directory

The bin directory is the root directory for content server startup files. It contains the intradoc.cfg file and the executable files that run the content server services, applets, and utilities. It is located at DomainHome/ucm/short-product-id/bin, where short-product-id specifies whether it is for Content Server, Inbound Refinery, or Records Manager.

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 content server services, applets, and utilities.

Note:

If the content server is set up as an automatic service and you attempt to start a content server service (IdcServer or IdcServerNT) from the command line, you receive an error message: The port could not be listened to and is already is use.

The intradoc.cfg file is used to define system variables for the content server, including directory, Internet, and refinery settings. Several of these variables can be set using the content server's System Properties utility.

The following is a typical intradoc.cfg file:

<?cfg jcharset="Cp1252"?>
#Content Server Directory Variables
IntradocDir=C:/oracle/idcm1/
WebBrowserPath=C:/Program Files/Internet Explorer/iexplore.exe
CLASSPATH=$COMPUTEDCLASSPATH;$SHAREDDIR/classes/jtds.jar

#Additional Variables
HTMLEditorPath=C:/Program Files/Windows XP/Accessories/wordpad.exe
JAVA_SERVICE_EXTRA_OPTIONS=-Xrs

2.1.3 config Directory

The config directory stores global content server configuration information. This directory can be located elsewhere, but the default location is DomainHome/ucm/short-product-id/config.

Element Description
config.cfg file Defines system configuration variables.

The config.cfg file is used to define global variables for the content server system. Several of these variables can be set using the content server's System Properties utility or by modifying the variables on the Admin Server General Configuration page.

The following is a typical config.cfg file:

<?cfg jcharset="Cp1252"?>
#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:1433/oracle1;charset=UTF8;TDS=7.0
JdbcUser=sa
JdbcPassword=UADle/+jRz7Fi8D/VzTDaGUCwUaQgQjKOQQEtI0PAqA=
JdbcPasswordEncoding=Intradoc
DatabasePreserveCase=0

#Internet Variables
HttpServerAddress=jwilsonnote
MailServer=mail.company.com
SysAdminAddress=sysadmin@company.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

2.1.4 components Directory

The IntradocDir/data/components directory contains the files that the content server uses to configure system components:

Element Description
idcshort-product-id_components.hda Identifies components that have been added to the content server system and whether they are enabled or disabled. Example: idccs_components.hda.
component.hda Identifies the configuration status for a component.

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=M/d{/yy} {h:mm[:ss] {aa}[zzz]}!tAmerica/Chicago!mAM,PM
@end
@ResultSet Components
2
name
location
help
components/help/help.hda
@end

2.1.5 resources/core Directory

The IdcHomeDir/resources directory contains two directories: admin and core. The resources/core directory contains files that the content server uses to assemble Web pages:

Element Description
config Holds base config files for the 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 the content server.
reports Holds templates for content server reports.
resources Holds resource definitions (queries, page resources, services, and other resource data) for the content server.
tables Holds IdocScript resource table definitions.
templates Holds templates for all content server pages (except reports).

The IdcHomeDir/resources/admin directory contains the following resource types:

Element Description
idoc Holds IdocScript dynamichtml definitions.
tables Holds IdocScript resource table definitions.
templates Holds templates for all content server pages (except reports).

2.1.6 weblayout Directory

The DomainHome/ucm/short-product-id/weblayout directory contains the files that are available to the Web server for display on the various pages of the content server Web site:

Element Description
groups Holds the web-viewable content items and dynamic server pages.
images Holds images, such as icons and home page graphics.
resources Holds layouts, skins, and schema information.