1/19
Contents
Title and Copyright Information
Preface
Audience
Document Organization
Documentation Accessibility
Related Documents
Conventions
New and Changed Features
New Features for 11
g
Release 1 (11.1.1)
Changed Features for 11
g
Release 1 (11.1.1)
1
Introduction to Customizing Your Oracle UCM Instance
1.1
Customization Types
1.2
Customization Planning
1.3
Recommended Skills and Tools
1.4
Troubleshooting
1.4.1
Viewing Server Errors
1.4.2
Viewing Page Data
1.4.3
Monitoring Resource Loading
2
Oracle UCM Architecture
2.1
Oracle UCM Directories and Files
2.1.1
Terminology for Oracle UCM Directories
2.1.2
The bin Directory
2.1.3
The config Directory
2.1.4
The components Directory
2.1.5
The resources Directory
2.1.6
The weblayout Directory
2.2
Resources
2.3
Oracle Content Server Behavior
2.3.1
Startup Behavior
2.3.1.1
Startup Steps
2.3.1.2
Effects of Configuration Loading
2.3.2
Resource Caching
2.3.3
Oracle Content Server Requests
2.3.3.1
Page Retrieval
2.3.3.2
Oracle Content Server Services
2.3.3.3
Search Services
2.3.4
Page Assembly
2.3.5
Database Interaction
2.3.6
Localized String Resolution
3
Working with Standard, Server, and Custom Components
3.1
Components Overview
3.1.1
Component Wizard
3.1.2
Advanced Component Manager
3.1.3
ComponentTool
3.1.4
Component Files Overview
3.1.5
Enabling and Disabling Components
3.2
About Directories and Files
3.2.1
HDA Files
3.2.1.1
Elements in HDA Files
3.2.1.2
The idc_components.hda File
3.2.1.3
Component Definition Files
3.2.2
Custom Resource Files
3.2.3
Data Binder
3.2.3.1
LocalData
3.2.3.2
ResultSets
3.2.3.3
Environment
3.2.4
Manifest File
3.2.5
Other Files
3.2.5.1
Customized Site Files
3.2.5.2
Component ZIP File
3.2.5.3
Custom Installation Parameter Files
3.2.6
Typical Directory Structure
3.3
Development Recommendations
3.3.1
Creating a Component
3.3.2
Working with Component Files
3.3.3
Using a Development Instance
3.3.4
Component File Organization
3.3.5
Naming Conventions
3.4
Component File Detail
3.4.1
The idc_components.hda File
3.4.1.1
Contents of idc_components.hda
3.4.1.2
Components ResultSet
3.4.2
Component Definition (Glue) File
3.4.2.1
ResourceDefinition ResultSet
3.4.2.2
MergeRules ResultSet
3.4.2.3
Filters ResultSet
3.4.2.4
ClassAliases ResultSet
3.5
Resources Detail
3.5.1
HTML Include
3.5.1.1
The Super Tag
3.5.1.2
Editing an HTML Include Resource
3.5.2
Dynamic Data Tables
3.5.2.1
Specifying Table Formats
3.5.2.2
Editing a Dynamic Data Table Resource
3.5.2.3
Specifying Table Properties
3.5.2.4
Using Dynamicdata Idoc Script Functions
3.5.3
String
3.5.3.1
String Parameters
3.5.3.2
Editing a String Resource
3.5.4
Dynamic Tables
3.5.4.1
Merge Rules for Dynamic Tables
3.5.4.2
Editing a Dynamic Table Resource
3.5.5
Static Tables
3.5.5.1
Merge Rules for Static Tables
3.5.5.2
Editing a Static Table Resource
3.5.6
Query
3.5.6.1
Query Example
3.5.6.2
Editing a Query Resource
3.5.7
Service
3.5.7.1
Service Example
3.5.7.2
Editing a Service Resource
3.5.8
Templates
3.5.8.1
Template and Report Pages
3.5.8.2
Editing a Template Resource
3.5.9
Environment
3.5.9.1
Environment Resource Example
3.5.9.2
Editing an Environment Resource
3.6
Installing Components
3.6.1
Installing a Component with Component Manager
3.6.2
Installing a Component with Component Wizard
3.6.3
Installing a Component with ComponentTool
4
Changing the Look and Navigation of the Oracle Content Server Interface
4.1
Modifying the Oracle Content Server Interface
4.1.1
Skins and Layouts
4.1.1.1
Types of Skins and Layouts
4.1.1.2
Selecting Skins and Layouts
4.1.1.3
Configuration Entries
4.1.1.4
Anonymous User Interface
4.1.2
Customizing the Interface
4.1.2.1
About Dynamic Publishing
4.1.2.2
Creating New Layouts
4.1.3
Optimizing the Use of Published Files
4.1.3.1
Bundling Files
4.1.3.2
Referencing Published Files
4.2
Using Dynamic Server Pages to Alter the Navigation of Web Pages
4.2.1
About Dynamic Server Pages
4.2.2
Page Types
4.2.2.1
IDOC File
4.2.2.2
HCST File
4.2.2.3
HCSP File
4.2.2.4
HCSF File
4.2.3
Creating Dynamic Server Pages
4.2.4
Syntax
4.2.4.1
Idoc Script Tags
4.2.4.2
Comparison Operators
4.2.4.3
Special Characters
4.2.4.4
Referencing Metadata
4.2.5
Idoc Script Functions
4.2.5.1
docLoadResourceIncludes Function
4.2.5.2
executeService Function
4.2.6
Development Recommendations
4.2.6.1
General Tips
4.2.6.2
HCSF Tips
4.2.7
HCSF Pages
4.2.7.1
Load Section
4.2.7.2
Data Section
4.2.7.3
Form Section
4.2.8
Working with Dynamic Server Pages
4.2.8.1
HCST and HCSP Example
4.2.8.2
HCSF Example
4.2.8.3
Common Code for Forms
5
Modifying System Functionality
5.1
Changing System Settings
5.2
Using Components
5.3
Changing Configuration Information
5.4
Customizing Services
5.5
Generating Action Menus
5.5.1
Creating Display Tables
5.5.1.1
Headline View Tables
5.5.1.2
Thumbnail View Tables
5.5.2
Customizing Action Menus�
6
Integrating Oracle UCM with Enterprise Applications
6.1
Overview of Integration Methods
6.2
JSP Integration
6.2.1
JSP Execution
6.2.2
Tomcat
6.2.3
Features
6.2.4
Configuring JSP Support
6.2.5
Loading Example Pages
6.3
Java 2 Enterprise Edition Integration (J2EE)
6.4
Web Services
6.4.1
Web Services Framework
6.4.2
Virtual Folders and WebDAV Integration
6.4.2.1
Virtual Folders
6.4.2.2
WebDAV Integration
7
Using the IdcCommand Utility to Access Services
7.1
Overview of IdcCommand Utility
7.2
IdcCommand Setup and Execution
7.3
Command File
7.3.1
Command File Syntax
7.3.2
Precedence
7.3.3
Special Tags and Characters
7.4
Configuration Options
7.4.1
Command File
7.4.2
User
7.4.3
Log File
7.4.4
Connection Mode
7.5
Running IdcCommand
7.6
Using the Launcher
7.6.1
Quotation Rules
7.6.2
Computed Settings
7.6.3
Launcher Environment Variables
7.6.4
User Interface
7.6.5
Configuring the Launcher
7.6.6
Configuration File Example
7.7
Calling Services Remotely
8
Using the COM API for Integration
8.1
Introduction to COM Integration
8.2
ActiveX Interface
8.2.1
Setting Up IdcCommandUX
8.2.2
Calling IdcCommandUX from a Visual Basic Environment
8.2.3
Calling IdcCommandUX from a Visual C++ Environment
8.2.4
Executing Services
8.2.5
Calling IdcCommandUX from an Active Server Page (ASP)
8.2.6
Formatting with a Resource Include
8.2.7
Connecting to Oracle Content Server from a Remote System
8.3
IdcCommandUX Methods
8.3.1
addExtraheadersForCommand
8.3.2
closeServerConnection
8.3.3
computeNativeFilePath
8.3.4
computeURL
8.3.5
computeWebFilePath
8.3.6
connectToServer
8.3.7
executeCommand
8.3.8
executeFileCommand
8.3.9
forwardRequest
8.3.10
getLastErrorMessage
8.3.11
initRemote
8.4
OCX Interface
8.5
IdcClientOCX Component
8.5.1
IdcClient OCX Description
8.5.1.1
General Description
8.5.1.2
Events, Methods, and Properties
8.5.1.3
IdcClient OCX Interface
8.5.2
IdcClient OCX Control Setup
8.5.2.1
Setting Up the IdcClient OCX Component
8.5.2.2
Creating a Visual Interface
8.6
IdcClient Events
8.6.1
IntradocBeforeDownload
8.6.2
IntradocBrowserPost
8.6.3
IntradocBrowserStateChange
8.6.4
IntradocRequestProgress
8.6.5
IntradocServerResponse
8.7
IdcClient OCX Methods
8.7.1
AboutBox
8.7.2
Back
8.7.3
CancelRequest
8.7.4
DoCheckoutLatestRev
8.7.5
DownloadFile
8.7.6
DownloadNativeFile
8.7.7
Drag
8.7.8
EditDocInfoLatestRev
8.7.9
Forward
8.7.10
GoCheckinPage
8.7.11
Home
8.7.12
InitiateFileDownload
8.7.13
InitiatePostCommand
8.7.14
Move
8.7.15
Navigate
8.7.16
NavigateCgiPage
8.7.17
Refresh Browser
8.7.18
SendCommand
8.7.19
SendPostCommand
8.7.20
SetFocus
8.7.21
ShowDMS
8.7.22
ShowDocInfoLatestRev
8.7.23
ShowWhatsThis
8.7.24
StartSearch
8.7.25
Stop
8.7.26
UndoCheckout
8.7.27
ViewDocInfo
8.7.28
ViewDocInfoLatestRev
8.7.29
ZOrder
8.8
IdcClient Properties
8.8.1
ClientControlledContextValue
8.8.2
HostCgiUrl
8.8.3
Password
8.8.4
UseBrowserLoginPrompt
8.8.5
UseProgressDialog
8.8.6
UserName
8.8.7
Working Directory
8.9
ODMA Integration
8.9.1
ODMA Client
8.9.2
ODMA Interfaces
9
Using Remote Intradoc Client (RIDC)
9.1
Introduction to RIDC
9.1.1
RIDC Protocols
9.1.2
SSL Communication
9.1.3
MBeans Implementation
9.2
Initializing RIDC
9.3
Configuring Clients
9.4
Authenticating Users
9.5
Using Services
9.6
Handling Connections
9.6.1
Closing Resources
9.6.2
Handling Connection Pooling
9.7
Sending and Receiving Streams
9.8
Using RIDC Objects in JSP and JSPX Pages
9.9
Reusing Binders for Multiple Requests
9.10
Providing User Security
9.11
Configuring SSL Communication with Oracle Content Server
9.11.1
Installing and Enabling the SecurityProviders Component
9.11.2
Configuring an Incoming Provider for SSL Communication
9.11.3
Creating Self-Signed Key Pairs and Certificates
9.11.3.1
Creating the Client and Server Keys
9.11.3.2
Self-Signing the Certificates
9.11.3.3
Exporting the Certificates
9.11.3.4
Importing the Certificates
9.12
Using Tables for Content Items, the Search Index, and the File Store
9.12.1
Finding Information for Each Content Item
9.12.2
Using a Search Index
9.12.3
Using the File Store Provider
10
Using Content Integration Suite (CIS)
10.1
CIS Architecture
10.2
Access Through the UCPM API
10.3
UCPM API Methodology
10.4
CIS Initialization
10.4.1
Initialization
10.4.2
SCSInitializeServlet
10.5
Integration in a Web Environment
10.6
Class Loading
10.6.1
Custom Class Loader
10.6.2
Class Loader Usage
10.7
Object Creation
10.8
Interaction with the UCPM API
10.9
IContext Interface
10.10
ICISObject Interface
10.10.1
Property Accessors
10.10.2
Property Object Types
10.10.3
Property Collections
10.11
Adapter Configuration File
10.11.1
The adapter Element
10.11.2
The config Element
10.12
Access to the SCS API
10.13
SCS API Objects
10.13.1
ISCSObject Interface
10.13.2
ICISTransferStream Interface
10.13.3
ISCSServerBinder Interface
10.13.4
ISCSServerResponse Interface
10.13.5
ISCSRequestModifier Interface
10.14
SCS API Servlets
10.14.1
Servlet Descriptions
10.14.2
SCS Servlet Parameters
10.14.2.1
SCSFileDownloadServlet
10.14.2.2
SCSDynamicConverterServlet
10.14.2.3
SCSDynamicURLServlet
10.14.3
Servlet Security
10.14.4
Servlets and API Interaction
10.15
SCS APIs
10.15.1
SCS Search API
10.15.2
SCS File API
10.15.3
SCS Document APIs
10.15.3.1
ISCSDocumentCheckinAPI
10.15.3.2
ISCSDocumentCheckoutAPI
10.15.4
SCS Workflow API
11
Using the Java Content Repository Adapter
11.1
Introduction to Using the Java Content Repository Adapter
11.1.1
JCR Data Model
11.1.2
Oracle Content Server JCR Adapter Data Model
11.2
Installing Required APIs and Runtime Libraries
11.2.1
Installing ADF Runtime Libraries
11.2.2
Deploying Remote Intradoc Client (RIDC)
11.2.3
Deploying the JCR API
11.2.4
Installing the JCR Integration Libraries
11.2.5
Installing the XML Integration Files
11.3
Deploying the JCR Adapter
11.4
Configuring Communication with Oracle Content Server
11.4.1
Supplying a Communication Method
11.4.2
Configuring Socket Communication (Listener Port)
11.4.3
Configuring Secure Socket Communication (SSL)
11.4.4
Configuring Web Communication (Web Server Filter)
11.4.5
Configuring the User Agent
11.4.6
Supplying Cache Settings
11.5
Using Tables for Content Items, the Search Index, and the File Store
11.5.1
Finding Information for Each Content Item
11.5.2
Using a Search Index
11.5.3
Using the File Store Provider
12
Using Oracle UCM Web Services
12.1
Overview of Oracle UCM Web Services
12.2
Oracle UCM Web Services
12.3
Installation and Configuration
12.4
Security
12.4.1
Configuring WS-Security through WS-Policy
12.4.2
Configuring SAML Support
12.4.2.1
Configuring a Keystore
12.4.2.2
Configuring Server JPS to Use the Keystore
12.4.2.3
Creating a Client CSF
12.4.2.4
Configuring a Java Client to Use the Keystore and CSF
13
Customizing DesktopTag
13.1
About the DesktopTag Component
13.2
System Requirements
13.3
DesktopTag Component Operation
13.3.1
File Get Operation
13.3.2
File Check-In Operation
13.4
Using the DesktopTag Component
13.4.1
Viewing Custom Properties
13.4.2
Checking in Documents from Outside Oracle Content Server
13.5
Configuring the DesktopTag Component
13.5.1
DesktopTagFormats Property
13.5.2
DesktopTagPrefix Property
13.5.3
DesktopTagFields Property
13.5.4
DesktopTagPrefixCustom Property
13.5.5
DesktopTagFieldsCustom Property
13.5.6
DesktopTagPrefixExtended Property
13.5.7
DesktopTagFieldsExtended Property
13.5.8
DefaultTaskPaneUrl Property
13.5.9
DesktopTagLog Property
13.5.10
DesktopTagFormatsExclude Property
A
Using WSDL Generator and SOAP
A.1
Overview
A.2
Using Web Services
A.2.1
Web Services Framework
A.2.1.1
XML Data
A.2.1.2
WSDL Interface
A.2.1.3
SOAP Communication
A.2.1.4
UDDI Registry
A.2.1.5
DIME: Message Format
A.2.1.6
How the Enabling Technologies Work Together
A.2.2
Implementation Architecture
A.2.3
Implementation on .NET
A.2.4
The SOAP Protocol
A.3
SOAP Clients
A.3.1
Using the Java SOAP Client
A.4
SOAP Service Calls
A.4.1
SOAP Packet Format
A.4.1.1
HTTP Headers
A.4.1.2
Namespaces
A.4.1.3
Nodes
A.4.2
Special Characters
A.5
Using Active Server Pages
A.5.1
Sample SOAP Request
A.5.2
Sample Active Server Page
A.6
Using WSDL Files
A.6.1
Understanding WSDL Files
A.6.1.1
WSDL File Structure
A.6.2
Sample WSDL File
A.6.3
Generating WSDL Files
A.6.4
Generating Proxy Class from WSDL Files
A.7
Creating a Custom WSDL Using Administration Pages
A.8
Sample Service Calls with SOAP Response/Request
A.8.1
Ping the Server
A.8.1.1
Required Parameters
A.8.1.2
SOAP Request
A.8.1.3
Response
A.8.2
Add a New User
A.8.2.1
Required Parameters
A.8.2.2
Optional Parameters
A.8.2.3
Optional Attribute Information
A.8.2.4
SOAP Request
A.8.2.5
Response
A.8.3
Edit Existing User
A.8.3.1
Required Parameters
A.8.3.2
Optional Parameters
A.8.3.3
Optional Attribute Information
A.8.3.4
SOAP Request
A.8.3.5
Response
A.8.4
Get User Information
A.8.4.1
Required Parameters
A.8.4.2
SOAP Request
A.8.4.3
Response
A.8.5
Delete User
A.8.5.1
Required Parameters
A.8.5.2
SOAP Request
A.8.5.3
Response
A.8.6
Check in Content Item
A.8.6.1
Required Parameters
A.8.6.2
Additional Parameters
A.8.6.3
Optional Parameters
A.8.6.4
SOAP Request
A.8.6.5
Response
A.8.7
Check out Content Item
A.8.7.1
Required Parameters
A.8.7.2
Optional Parameters
A.8.7.3
SOAP Request
A.8.7.4
Response
A.8.8
Undo Content Item Checkout
A.8.8.1
Required Parameters
A.8.8.2
Optional Parameters
A.8.8.3
SOAP Request
A.8.8.4
Response
A.8.9
Get Content Item Information
A.8.9.1
Required Parameters
A.8.9.2
SOAP Request
A.8.9.3
Response
A.8.10
Get File
A.8.10.1
Required Parameters
A.8.10.2
Optional Parameters
A.8.10.3
SOAP Request
A.8.10.4
Response
A.8.11
Get Search Results
A.8.11.1
Required Parameters
A.8.11.2
Optional Parameters
A.8.11.3
SOAP Request
A.8.11.4
Response
A.8.12
Get Table Data
A.8.12.1
Required Parameters
A.8.12.2
SOAP Request
A.8.12.3
Response
A.8.13
Get Criteria Workflow Information
A.8.13.1
REquired Parameters
A.8.13.2
SOAP Request
A.8.13.3
Response
Index
Scripting on this page enhances content navigation, but does not change the content in any way.