Go to main content
1/49
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
What's New in This Guide
New and Changed Features for Release 12c (12.2.1.3.0)
New and Changed Features for Release 12c (12.2.1.1)
New and Changed Features for Release 12c (12.2.1)
Other Significant Changes in this Document for 12c (12.2.1)
Part I Getting Started with Oracle WebCenter Content
1
Introduction to Developing with Oracle WebCenter Content
1.1
Overview of WebCenter Content Architecture
1.1.1
WebCenter Content Directories and Files
1.1.1.1
Terminology for WebCenter Content Directories
1.1.1.2
The bin Directory
1.1.1.3
The config Directory
1.1.1.4
The components Directory
1.1.1.5
The custom Directory
1.1.1.6
The resources Directory
1.1.1.7
The weblayout Directory
1.1.2
Resources
1.2
Customization Types
1.3
Customization Planning
1.4
Recommended Skills and Tools for Customizing Content Server
1.5
Content Server Behavior
1.5.1
Startup Behavior
1.5.1.1
Startup Steps
1.5.1.2
Effects of Configuration Loading
1.5.2
Resource Caching
1.5.3
Page Assembly
1.5.4
Database Interaction
1.5.5
Localized String Resolution
1.5.6
Application Integrations
2
Installing and Configuring Oracle JDeveloper
2.1
Install JDeveloper
2.2
Install WebCenter Content Connection Extension for JDeveloper
2.3
Creating an Integrated WebLogic Server Domain
2.4
Configuring JDeveloper for Defining Seeded Customizations
Part II Working with the Idoc Script Custom Scripting Language
3
Introduction to the Idoc Script Custom Scripting Language
3.1
Idoc Naming Conventions
3.2
Idoc Script Syntax
3.2.1
Idoc Script Tags
3.2.2
Idoc Script Comments
3.3
Idoc Script Uses
3.3.1
Includes
3.3.1.1
Include Example
3.3.1.2
Super Tag
3.3.1.3
Super Tag Example
3.3.2
Variables
3.3.2.1
Variable Creation
3.3.2.2
Variable References
3.3.2.3
Variable Values
3.3.2.4
Comma Separators
3.3.2.5
Variable Reference in a Conditional
3.3.2.6
Variable Reference Search Order
3.3.2.7
Regular Variables
3.3.3
Functions
3.3.3.1
Personalization Functions
3.3.4
Conditionals
3.3.4.1
Conditional Example
3.3.5
Looping
3.3.5.1
ResultSet Looping
3.3.5.2
ResultSet Looping Example
3.3.5.3
While Looping
3.3.5.4
While Looping Example
3.3.5.5
End a Loop
3.3.6
Administration Interface
3.3.6.1
Workflow Admin
3.3.6.2
Web Layout Editor
3.3.6.3
Batch Loader
3.3.6.4
Archiver
3.3.6.5
System Properties
3.3.6.6
Email
3.4
Special Keywords
3.4.1
Keywords Versus Functions
3.4.1.1
exec Keyword
3.4.1.2
eval Function
3.4.1.3
include Keyword
3.4.1.4
inc Function
3.5
Operators
3.5.1
Comparison Operators
3.5.2
Special String Operators
3.5.3
Numeric Operators
3.5.4
Boolean Operators
3.6
Metadata Fields
3.6.1
Metadata Field Naming
3.6.2
Standard Metadata Fields
3.6.2.1
Common Metadata Fields
3.6.2.2
Other Fields
3.6.3
Option Lists
3.6.3.1
Internal Option Lists
3.6.3.2
Option List Script
3.6.3.3
Methods for Creating an Option List
3.6.4
Metadata References in Dynamic Server Pages
3.7
Merge Includes for Formatting Results
3.8
Scoped Local Variables
4
Using Idoc Script Variables and Functions with Oracle WebCenter Content
4.1
Using Different Types of Idoc Script Variables and Functions
4.1.1
Conditional Dynamic Variables
4.1.2
Dynamic Variables
4.1.3
Environment Variables
4.1.4
Global Functions
4.1.5
Page Variables
4.1.5.1
Page Display Variables
4.1.5.2
Field Display Variables
4.1.5.2.1
Field Information Variables
4.1.5.2.2
Common Field Display Variables
4.1.5.2.3
Other Field Display Variables
4.1.6
Read-Only Variables
4.1.6.1
Template Read-Only Variables
4.1.6.2
User Read-Only Variables
4.1.6.3
Content Read-Only Variable
4.1.6.4
Other Read-Only Variable
4.1.7
Settable Variables
4.1.8
Workflows
4.1.8.1
Workflow Functions
4.1.8.2
Workflow Variables
4.1.9
Value Variables
4.2
Using Idoc Script Variables and Functions with Different Features of Oracle WebCenter Content
4.2.1
Batch Loader
4.2.2
Clients
4.2.3
Content Items
4.2.4
Content Profiles
4.2.5
Content Server
4.2.6
Conversion
4.2.6.1
Inbound Refinery
4.2.6.2
Dynamic Converter
4.2.7
Database
4.2.8
Date and Time
4.2.9
Debugging
4.2.10
Directories and Paths
4.2.11
Dynamicdata
4.2.12
Field Display
4.2.13
Idoc Script
4.2.13.1
Keywords
4.2.14
Indexing
4.2.15
Localization
4.2.16
Page Display
4.2.17
Personalization
4.2.18
ResultSets
4.2.19
Schemas
4.2.20
Searching
4.2.21
Security
4.2.21.1
Internal Security
4.2.21.2
External Security
4.2.22
Strings
4.2.23
Templates
4.2.24
Users
4.2.25
Web Servers
4.2.26
Workflow
4.2.26.1
Global Function
4.2.26.2
Workflow Functions
4.2.26.3
Other Variables
Part III Changing the Look and Feel of the Content Server Interface
5
Customizing the Content Server Interface
5.1
About Customizing the Content Server Interface
5.1.1
Types of Skins and Layouts
5.1.2
Skins
5.1.3
Layouts
5.2
Choosing a Different Skin or Layout
5.3
Configure a Default Skin and Layout for New Users and Guests
5.4
Modify the Template for a Skin or Layout
5.4.1
About Dynamic Publishing
5.4.2
IdocScript Files for Dynamic Publishing
5.4.3
Navigation Engine Reference
5.4.3.1
Dynamic Data Tables for Content Server Navigation
5.4.3.1.1
CoreMenuItems
5.4.3.1.2
CoreMenuItemRelationships
5.4.3.1.3
CoreMenuItemsFlags
5.4.3.1.4
CoreMenuItemsImages
5.4.3.1.5
CoreMenuItemsDynamicLoadCallbacks
5.4.3.1.6
CoreMenuItemsExitLinks
5.4.3.1.7
CoreMenuItemsTrayDocLinks
5.4.3.2
List of LinkType Values
5.4.3.3
List of Flags
5.4.3.4
Global Javascript Variables
5.4.3.5
Access to Menu Items and Nodes
5.4.3.6
11g Support for NavBuilder Functions
5.5
Alter the Anonymous User Interface
5.5.1
Altering the Anonymous User Interface
5.6
Changing the URL of the Login Page
5.7
Creating and Publishing a New Layout
5.8
Optimize the Use of Published Files
5.8.1
Bundling Files
5.8.2
Referencing Published Files
6
Customizing the WebCenter Content User Interface
6.1
Customizing the WebCenter Content User Interface
6.2
Install and Configure Oracle JDeveloper Studio Edition
6.3
Setting up the WccAdfCustomization Application
6.4
Define a Custom Skin and Generating WccAdfCustomSkin.jar
6.4.1
Designing and Testing Customizations in the Custom Skin
6.4.1.1
Customizing the Branding Bar Logo with Your Own Images
6.4.1.2
Customizing the Default Font Size
6.4.1.3
Customizing Selectors
6.4.2
Packaging the Custom Skin As WccAdfCustomSkin.jar
6.5
Define MDS Seeded Customizations and Generating WccAdfCustomization.mar
6.5.1
Defining customer Layer Values
6.5.2
Defining Seeded Customizations for Each Layer Value of the customer Layer
6.5.3
Defining MDS Seeded Customizations
6.5.4
Packaging Seeded Customizations in WccAdfCustomization.mar
6.6
Applying Customizations to the Installed Environment
6.6.1
Applying a Custom Skin
6.6.2
Applying the Seeded Customizations to the WebCenter Content User Interface
7
Creating Dynamic Server Pages
7.1
About Dynamic Server Pages
7.1.1
Page Types
7.1.1.1
IDOC File
7.1.1.2
HCST File
7.1.1.3
HCSP File
7.1.1.4
HCSF File
7.2
Altering the Appearance and Navigation of Web Pages
7.2.1
Syntax
7.2.1.1
Idoc Script Expressions
7.2.1.2
Comparison Operators
7.2.1.3
Special Characters
7.2.1.4
References to Metadata
7.2.2
Idoc Script Functions
7.2.2.1
docLoadResourceIncludes Function
7.2.2.1.1
Requirements for Calling the docLoadResourceIncludes Function
7.2.2.1.2
Parameters
7.2.2.2
executeService Function
7.2.3
Development Recommendations
7.2.3.1
General Guidelines
7.2.3.2
HCSF Guidelines
7.2.4
HCSF Pages
7.2.4.1
Load Section
7.2.4.1.1
HTML Declaration
7.2.4.1.2
docLoadResourceIncludes Function
7.2.4.1.3
Meta Element
7.2.4.1.4
Variables and Includes
7.2.4.2
Data Section
7.2.4.2.1
Data Section Structure
7.2.4.2.2
The idcformrules Element
7.2.4.2.3
Metadata Elements
7.2.4.2.4
Nested Elements
7.2.4.2.5
Referencing XML Elements
7.2.4.2.6
Form Elements
7.2.4.2.7
ResultSets
7.2.4.3
Form Section
7.2.4.3.1
Form Begin
7.2.4.3.2
Form Properties
7.2.4.3.3
Form Fields
7.2.4.3.4
Form Buttons
7.2.4.3.5
Form End
7.3
Creating an IDOC File with Custom Includes for Dynamic Server Pages
7.4
Creating an HCST Page
7.5
Creating an HCSP Page
7.6
Creating an HCSF Page
7.6.1
Common Code for Forms
7.6.1.1
Retrieving File Information
7.6.1.2
Referencing a File Extension
7.6.1.3
Defining Form Information
7.6.1.4
Defining Form Fields
7.6.1.5
Defining Hidden Fields
7.6.1.6
Submitting a Form
7.7
Verifying the Display of an HCST, HCSP, or HCSF Page in a Web Browser
Part IV Modifying the Functionality of Content Server
8
Changing System Settings
8.1
About Changing System Settings
8.2
Changing System Settings Through the Configuration Pages
8.3
Changing System Settings Through the System Properties Application
8.4
Customizing the Library and System Home Page with the Web Layout Editor
8.5
Defining Security and Accounts for Users with the User Admin Application
9
Changing Configuration Information
9.1
About Changing Configuration Information
9.2
Changing Configurations with the Idoc Script Custom Scripting Language
9.3
Changing Configurations with Development Tools and Technologies
10
Customizing Services
10.1
About Customizing Services
10.2
Customizing Services for Communicating with Content Server
10.3
Customizing Services for Accessing the Database
11
Generating Actions Menus
11.1
About Generating Actions Menus
11.2
Creating Display Tables
11.2.1
Headline View Tables
11.2.2
Classic View Tables
11.2.3
Thumbnail View Tables
11.3
Customizing Actions Menus
11.4
Customizing Actions Menus
Part V Customizing Content Server with Components
12
Getting Started with Content Server Components
12.1
About Standard, System, and Custom Components
12.1.1
Component Files Overview
12.1.2
Using Components
12.1.2.1
Advantages of Using Components
12.1.2.2
Constraints
12.1.2.3
Installed Components
12.1.3
About Directories and Files
12.1.3.1
HDA Files
12.1.3.1.1
Elements in HDA Files
12.1.3.1.2
The idccs_components.hda, idcibr_components.hda, or idcurm_components.hda File
12.1.3.1.3
Component Definition Files
12.1.3.2
Custom Resource Files
12.1.3.3
Data Binder
12.1.3.3.1
LocalData
12.1.3.3.2
ResultSets
12.1.3.3.3
Environment
12.1.3.4
Manifest File
12.1.3.5
Other Files
12.1.3.5.1
Customized Site Files
12.1.3.5.2
Component ZIP File
12.1.3.5.3
Custom Installation Parameter Files
12.1.3.6
Typical Directory Structure
12.1.4
Development Recommendations
12.1.4.1
Creating a Component
12.1.4.2
Work with Component Files
12.1.4.3
Using a Development Content Server
12.1.4.4
Component File Organization
12.1.4.5
Naming Conventions
12.2
Tools for Managing Components
12.2.1
Component Wizard
12.2.2
Managing Custom Components with Advanced Component Manager
12.2.3
ComponentTool
12.3
Component Files
12.3.1
The idc Product _components.hda File
12.3.2
Components ResultSet
12.3.3
Component Definition (Glue) File
12.3.3.1
ResourceDefinition ResultSet
12.3.3.1.1
ResourceDefinition ResultSet Columns
12.3.3.2
MergeRules ResultSet
12.3.3.2.1
MergeRules ResultSet Columns
12.3.3.3
Filters ResultSet
12.3.3.4
ClassAliases ResultSet
12.4
Resources for Assembling Web Pages
13
Enabling and Disabling Components for Content Server
13.1
About Enabling and Disabling Components
13.2
Enabling a Component
13.3
Disabling a Component
14
Updating Component Configurations
14.1
About Updating Component Configurations
14.2
Updating a Component Configuration with the Advanced Component Manager
14.3
Updating a Component Configuration Through the Configuration for instance Screen
15
Customizing Content Tracker
15.1
About Content Tracker
15.1.1
Content Tracker Accesses and Services
15.1.2
Content Tracker Components and Functions
15.1.2.1
DataBinder Dump Facility
15.1.2.1.1
Values for the DataBinder Dump Facility
15.1.2.1.2
Location of the DataBinder Object Dump Files
15.1.2.1.3
Names of the DataBinder Object Dump Files
15.1.2.2
Performance Optimization
15.1.2.3
Installation Considerations
15.2
Customizing Content Tracker with Configuration Variables
15.2.1
About Configuration Variables
15.2.1.1
Access Control Lists and Secure Mode
15.2.1.2
Values for the Security Checks Preference Variable
15.2.1.3
File Types for Entries in the SctAccessLog
15.2.2
Setting Content Tracker Configuration Variables
15.2.3
Tracking External Users and Content Items
15.3
Configuring Service Calls
15.3.1
About the Service Call Configuration File
15.3.1.1
General Service Call Logging
15.3.1.2
Extended Service Call Tracking Function
15.3.1.2.1
Service Call ResultSet Combinations
15.3.1.2.2
General Purpose Columns in the Output Table
15.3.1.3
Service Call Configuration File Contents
15.3.1.4
ResultSet Examples
15.3.1.4.1
ServiceExtraInfo ResultSet Entries
15.3.1.4.2
Linked Service Entries and Field Map ResultSets
15.3.2
About the Content Tracker Logging Service
15.3.3
Managing Service Call Information
15.3.3.1
Manually Editing the SctServiceFilter.hda File
15.3.3.2
Setting Required DataBinder Fields to Call the Content Tracker Logging Service
15.3.3.3
Calling the Content Tracker Logging Service from an Application
15.3.3.4
Calling the Content Tracker Logging Service from Idoc Script
15.3.4
Service Call Management and the User Interface
15.3.4.1
Adding, Editing, or Deleting Service Entries
15.3.4.2
Adding, Editing, or Deleting Field Map ResultSets
15.4
Customizing the Activity Metrics SQL Queries
15.4.1
Tracking Access to Content Items by External Users
15.5
Tracking Indirect Access to Content with Web Beacons
15.5.1
Web Beacon Use Cases
15.5.2
Web Beacon Overview
15.5.3
Web Beacon Object
15.5.4
Web Beacon References
15.5.4.1
Format Structure for URL References
15.5.4.2
Placement and Retrieval Scheme
15.5.4.3
Data Capture and Storage
15.5.5
Reduction Processing for Web Beacon References
15.5.6
Limitations and Guidelines
15.5.6.1
Limitations
15.5.6.2
Guidelines
15.5.7
Examples of Web Beacon Embedding
15.5.7.1
Embedded HTML Example
15.5.7.2
Embedded JavaScript Example
15.5.7.3
Served JavaScript Example
16
Customizing Content Categorizer
16.1
About Content Categorizer
16.2
Setting Up and Customizing Content Categorizer for Your Site
17
Downloading Custom Components
17.1
About Downloading Custom Components
17.2
Downloading a Component from the Advanced Component Manager
17.3
Downloading a Component from Oracle Technology Network
18
Creating Custom Components
18.1
About Creating Custom Components
18.2
Creating Resources for a Component
18.2.1
HTML Includes
18.2.1.1
The Super Tag
18.2.1.2
Editing an HTML Include Resource
18.2.2
Dynamic Data Tables
18.2.2.1
Specifying Table Formats
18.2.2.2
Editing a Dynamic Data Table Resource
18.2.2.3
Specifying Table Properties
18.2.2.3.1
Merge Properties
18.2.2.3.2
Assembly Properties
18.2.2.3.3
Sort Properties
18.2.2.3.4
Filter and Include Properties
18.2.2.4
Using Dynamicdata Idoc Script Functions
18.2.3
String Resources
18.2.3.1
String Parameters
18.2.3.2
Editing a String Resource
18.2.4
Dynamic Tables
18.2.4.1
Merge Rules for Dynamic Tables
18.2.4.2
Editing a Dynamic Table Resource
18.2.5
Static Tables
18.2.5.1
Merge Rules for Static Tables
18.2.5.2
Editing a Static Table Resource
18.2.6
Queries
18.2.6.1
Query Example
18.2.6.2
Editing a Query Resource
18.2.7
Services
18.2.7.1
Service Example
18.2.7.1.1
Attributes
18.2.7.1.2
Actions
18.2.7.2
Editing a Service Resource
18.2.8
Templates
18.2.8.1
Template and Report Pages
18.2.8.1.1
Template Page Example
18.2.8.1.2
Report Page Example
18.2.8.2
Editing a Template Resource
18.2.9
Environment Resources
18.2.9.1
Environment Resource Example
18.2.9.2
Editing an Environment Resource
18.3
Creating a Component Definition File
18.4
Restarting Content Server to Apply a Component
19
Installing Components
19.1
About Installing Components
19.2
Packaging a Component for Installation
19.3
Installing a Component with the Advanced Component Manager
19.4
Installing a Component with the Component Wizard
19.5
Installing a Component with the ComponentTool Utility
20
Uninstalling Components
20.1
About Uninstalling Components
20.2
Uninstalling a Component from Content Server
Part VI Customizing Records
21
Customizing Disposition Actions
21.1
About Customizing Disposition Actions
21.2
Managing Custom Dispositions
21.2.1
Creating or Editing a Custom Disposition Action
21.2.2
Viewing Information About a Custom Disposition Action
21.2.3
Deleting a Custom Disposition Action
21.3
Disabling a Custom Disposition Action
21.4
Creating a Custom Disposition Action
21.5
Create Disposition Rules for Physical Content
22
Customizing Bar Codes
22.1
About Customizing Bar Codes
22.2
Adding a Custom Bar Code Range
22.3
Processing Nonstandard Bar Code Data
22.3.1
Header and Footer Information
22.3.2
Data Information
22.3.2.1
Transaction Codes
22.3.2.1.1
Location
22.3.2.1.2
Object
23
Adding a Mobile Bar Code Reader
23.1
About Adding a Mobile Bar Code Reader
23.2
Installing Bar Code Scanner Software on a Mobile Device
23.3
Verifying Installation of the Mobile Bar Code Reader
24
Creating Custom Reports
24.1
About Creating Custom Reports
24.1.1
Creating Custom Reports using Default Templates
24.2
Creating Custom Templates
24.3
Creating Templates with Oracle Business Intelligence Publisher
24.4
Creating or Editing New Report Sources
24.5
Downloading a BI XML Data File
Part VII Integrating WebCenter Content into Your Environment
25
Getting Started with Integrating WebCenter Content into Your Environment
25.1
About Integration Methods
25.2
Overview of Web Services
25.3
Folders, Contribution Folders, and WebDAV Integration
25.3.1
Virtual Folders
25.3.2
WebDAV Integration
25.3.2.1
WebDAV Clients
25.3.2.2
WebDAV Servers
25.3.2.3
WebDAV Architecture
26
Configuring WebCenter Content Web Services for Integration
26.1
About Configuring WebCenter Content Web Services for Integration
26.1.1
Technologies for Web Services
26.1.2
WebCenter Content Web Services
26.2
Configuring Web Service Security Through Web Service Policies
26.3
Configuring SAML Support
26.3.1
Configuring a Keystore
26.3.2
Configuring JPS for WebCenter Content to Use the Keystore
26.3.3
Creating a Client CSF
26.3.4
Configuring a Java Client to Use the Keystore and CSF
27
Using the IdcCommand Utility to Access Content Server
27.1
About the IdcCommand Utility
27.2
Setting Up IdcCommand
27.2.1
Specifying a Command File
27.2.1.1
Command File Syntax
27.2.1.2
Precedence
27.2.1.3
Special Tags and Characters
27.2.2
Specifying Configuration Options
27.2.2.1
Command File
27.2.2.2
User
27.2.2.3
Log File
27.2.2.4
Connection Mode
27.3
Running IdcCommand
27.4
Using the Launcher
27.4.1
Quotation Rules
27.4.2
Computed Settings
27.4.3
Launcher Environment Variables
27.4.4
User Interface
27.4.5
Configuring the Launcher
27.4.6
Configuration File Example
27.5
Calling Services Remotely
28
Using the COM API for Integration
28.1
About the COM API
28.2
Calling Content Server Services with the IntradocClient OCX component
28.2.1
OCX Interface
28.2.2
IdcClient OCX Description
28.2.2.1
OCX Events
28.2.2.2
OCX Methods
28.2.2.3
OCX Properties
28.2.2.4
IdcClient OCX Interface
28.2.3
IdcClient OCX Control Setup
28.2.3.1
Setting Up the IdcClient OCX Component
28.2.3.2
Creating a Visual Interface
28.2.4
IdcClient Events
28.2.4.1
IntradocBeforeDownload
28.2.4.2
IntradocBrowserPost
28.2.4.3
IntradocBrowserStateChange
28.2.4.4
IntradocRequestProgress
28.2.4.5
IntradocServerResponse
28.2.5
IdcClient OCX Methods
28.2.5.1
AboutBox
28.2.5.2
Back
28.2.5.3
CancelRequest
28.2.5.4
DoCheckoutLatestRev
28.2.5.5
DownloadFile
28.2.5.6
DownloadNativeFile
28.2.5.7
Drag
28.2.5.8
EditDocInfoLatestRev
28.2.5.9
Forward
28.2.5.10
GoCheckinPage
28.2.5.11
Home
28.2.5.12
InitiateFileDownload
28.2.5.13
InitiatePostCommand
28.2.5.14
Move
28.2.5.15
Navigate
28.2.5.16
NavigateCgiPage
28.2.5.17
Refresh Browser
28.2.5.18
SendCommand
28.2.5.19
SendPostCommand
28.2.5.20
SetFocus
28.2.5.21
ShowDMS
28.2.5.22
ShowDocInfoLatestRev
28.2.5.23
ShowWhatsThis
28.2.5.24
StartSearch
28.2.5.25
Stop
28.2.5.26
UndoCheckout
28.2.5.27
ViewDocInfo
28.2.5.28
ViewDocInfoLatestRev
28.2.5.29
ZOrder
28.3
Using the ODMA API to Access Content Server from a Desktop Application
28.3.1
ODMA Client
28.3.2
ODMA Interfaces
29
Using RIDC to Access Content Server
29.1
About Remote Intradoc Client
29.1.1
Supported Protocols
29.1.2
Supported URL Formats
29.1.3
Required Environments
29.1.4
HttpClient Libraries
29.1.5
Convenience Classes
29.2
Initializing Connections
29.3
Configuring Clients
29.3.1
Configuring Clients for Intradoc Connections
29.3.2
Configuring SSL
29.3.3
Configuring JAX-WS
29.3.3.1
Setting LPA Mode for a Service
29.3.3.2
Setting a GPA Service Policy for a Domain
29.3.3.3
Setting a GPA Client Policy for a Domain
29.3.4
Add GPA for the Web Service Client
29.3.5
Changing Default Settings
29.4
Authenticating Users
29.5
Using Services
29.6
Handling Connection Pooling
29.7
Sending and Receiving Streams
29.8
Reusing Binders for Multiple Requests
29.9
Setting User Security
29.10
Using RIDC Filters
30
Accessing Imaging User Interface Functions Through URL Tools
30.1
About Accessing Imaging User Interface Functions Through URL Tools
30.2
Using URL Tool
30.3
Supported URL Tool Parameters
30.4
Viewer URL Tool
31
Using the Content Server JCR Adapter
31.1
About the Java Content Repository Adapter
31.1.1
JCR Data Model
31.1.2
JCR Adapter Data Model for Content Server
31.2
Installing Required APIs and Runtime Libraries
31.2.1
Installing ADF Runtime Libraries
31.2.2
Deploying Remote Intradoc Client (RIDC)
31.2.3
Deploying the JCR API
31.2.4
Installing the JCR Integration Libraries
31.2.5
Installing the XML Integration Files
31.3
Deploying the JCR Adapter
31.4
Configuring Communication with Content Server
31.4.1
Supplying a Communication Method
31.4.2
Configuring Socket Communication (Listener Port)
31.4.3
Configuring Secure Socket Communication (SSL)
31.4.4
Configuring Web Communication (Web Server Filter)
31.4.5
Configuring the User Agent
31.4.6
Supplying Cache Settings
31.5
Finding Information About a Content Item
31.5.1
Revisions
31.5.2
Documents
31.5.3
DocMeta
31.5.4
RevClasses
31.6
Using a Search Index
31.7
Using the File Store Provider
32
Configuring Web Services with WSDL, SOAP, and the WSDL Generator
32.1
About Configuring Web Services with WSDL, SOAP, and the WSDL Generator
32.1.1
Web Services Framework
32.1.1.1
XML Data
32.1.1.2
WSDL Interface
32.1.1.3
SOAP Communication
32.1.1.4
UDDI Registry
32.1.1.5
DIME Message Format
32.1.1.6
How the Enabling Technologies Work Together
32.1.1.7
Implementation Architecture
32.1.1.8
Implementation on .NET
32.1.1.9
The SOAP Protocol
32.2
Accessing Content Server with a SOAP Client
32.2.1
Using a Java SOAP Client
32.3
Calling Content Server Services with SOAP
32.3.1
SOAP Packet Format
32.3.1.1
HTTP Headers
32.3.1.2
Namespaces
32.3.1.3
Nodes
32.3.1.3.1
Service Node
32.3.1.3.2
Document Node
32.3.1.3.3
User Node
32.3.1.3.4
Optionlist Node
32.3.1.3.5
Option Subnode in an IDC Optionlist Node
32.3.1.3.6
Resultset Subnode
32.3.1.3.7
Row Subnode
32.3.1.3.8
Field Subnode
32.3.2
Special Characters
32.3.3
Sample Service Calls with SOAP Response/Request
32.3.3.1
Ping the Server
32.3.3.1.1
Required Parameters
32.3.3.1.2
SOAP Request
32.3.3.1.3
Response
32.3.3.2
Add a New User
32.3.3.2.1
Required Parameters
32.3.3.2.2
Optional Parameters
32.3.3.2.3
Optional Attribute Information
32.3.3.2.4
SOAP Request
32.3.3.2.5
Response
32.3.3.3
Edit Existing User
32.3.3.3.1
Required Parameters
32.3.3.3.2
Optional Parameters
32.3.3.3.3
Optional Attribute Information
32.3.3.3.4
SOAP Request
32.3.3.3.5
Response
32.3.3.4
Get User Information
32.3.3.4.1
Required Parameters
32.3.3.4.2
SOAP Request
32.3.3.4.3
Response
32.3.3.5
Delete User
32.3.3.5.1
Required Parameters
32.3.3.5.2
SOAP Request
32.3.3.5.3
Response
32.3.3.6
Check In Content Item
32.3.3.6.1
Required Parameters
32.3.3.6.2
Additional Parameters
32.3.3.6.3
Optional Parameters
32.3.3.6.4
SOAP Request
32.3.3.6.5
Response
32.3.3.7
Check out Content Item
32.3.3.7.1
Required Parameters
32.3.3.7.2
Optional Parameters
32.3.3.7.3
SOAP Request
32.3.3.7.4
Response
32.3.3.8
Undo Content Item Checkout
32.3.3.8.1
Required Parameters
32.3.3.8.2
Optional Parameters
32.3.3.8.3
SOAP Request
32.3.3.8.4
Response
32.3.3.9
Get Content Item Information
32.3.3.9.1
Required Parameters
32.3.3.9.2
SOAP Request
32.3.3.9.3
Response
32.3.3.10
Get File
32.3.3.10.1
Required Parameters
32.3.3.10.2
Optional Parameter
32.3.3.10.3
SOAP Request
32.3.3.10.4
Response
32.3.3.11
Get Search Results
32.3.3.11.1
Required Parameters
32.3.3.11.2
Optional Parameters
32.3.3.11.3
SOAP Request
32.3.3.11.4
Response
32.3.3.12
Get Table Data
32.3.3.12.1
Required Parameters
32.3.3.12.2
SOAP Request
32.3.3.12.3
Response
32.3.3.13
Get Criteria Workflow Information
32.3.3.13.1
Required Parameters
32.3.3.13.2
SOAP Request
32.3.3.13.3
Response
32.4
Using SOAP Packets in Active Server Pages
32.4.1
Sample SOAP Request
32.4.2
Sample Active Server Page
32.5
Generating WSDL Files to Access WebCenter Content
32.5.1
Understanding WSDL Files
32.5.1.1
WSDL File Structure
32.5.1.1.1
Data Type
32.5.1.1.2
Message
32.5.1.1.3
Port Type
32.5.1.1.4
Binding
32.5.1.1.5
Service and Port
32.5.2
Sample WSDL File
32.5.3
Generating WSDL Files
32.5.4
Generating Proxy Class from WSDL Files
32.6
Customizing WSDL Files
33
Customizing the DesktopTag Component
33.1
About the DesktopTag Component
33.2
Enabling the DesktopTag and OracleCleanContent Components
33.3
Checking Out and Checking In Content Items with DesktopTag
33.3.1
File Get Operation
33.3.2
File Check-In Operation
33.4
Adding Properties to Checked-Out Content Items
33.4.1
Viewing Custom Properties
33.4.2
Checking In Documents from Outside Content Server
33.5
Configuring the DesktopTag Component
33.5.1
DesktopTagFormats Property
33.5.2
DesktopTagPrefix Property
33.5.3
DesktopTagFields Property
33.5.4
DesktopTagPrefixCustom Property
33.5.5
DesktopTagFieldsCustom Property
33.5.6
DesktopTagPrefixExtended Property
33.5.7
DesktopTagFieldsExtended Property
33.5.8
DefaultTaskPaneUrl Property
33.5.9
DesktopTagLog Property
33.5.10
DesktopTagFormatsExclude Property
Part VIII Appendices
A
Idoc Script Functions and Variables
A.1
abortToErrorPage()
A.2
addEmptyOption
A.3
AdminAtLeastOneGroup
A.4
AdsSimpleAuth
A.5
AdsUserName
A.6
AdsUserPassword
A.7
AfterLogin
A.8
AllowCheckin
A.9
AllowCheckout
A.10
AllowIntranetUsers
A.11
AllowReview
A.12
AuthorAddress
A.13
AuthorDelete
A.14
AutoNumberPrefix
A.15
BatchLoaderPath
A.16
break()
A.17
BrowserVersionNumber
A.18
c
A.19
cacheInclude()
A.20
captionEntryWidth
A.21
captionFieldWidth
A.22
clearSchemaData()
A.23
ClientControlled
A.24
computeDocUrl()
A.25
computeRenditionUrl()
A.26
CONTENT_LENGTH
A.27
coreContentOnly
A.28
CURRENT_DATE
A.29
CURRENT_ROW
A.30
dateCurrent()
A.31
dcShowExportLink
A.32
ddAppendIndexedColumnResultSet()
A.33
ddAppendResultSet()
A.34
ddApplyTableSortToResultSet()
A.35
ddGetFieldList()
A.36
ddIncludePreserveValues()
A.37
ddLoadIndexedColumnResultSet()
A.38
ddLoadResultSet()
A.39
ddMergeIndexedColumnResultSet()
A.40
ddMergeResultSet()
A.41
ddMergeUsingIndexedKey()
A.42
ddSetLocal()
A.43
ddSetLocalByColumnsFromFirstRow()
A.44
ddSetLocalByColumnsFromFirstRowIndexed()
A.45
ddSetLocalEmpty()
A.46
ddSetLocalEmptyByColumns()
A.47
DefaultAccounts
A.48
defaultFieldInclude
A.49
defaultOptionListScript
A.50
DelimitedUserRoles
A.51
docLoadResourceIncludes()
A.52
docRootFilename()
A.53
DocTypeSelected
A.54
DocUrl
A.55
docUrlAllowDisclosure()
A.56
DownloadApplet
A.57
DownloadSuggestedName
A.58
dpGet()
A.59
dpPromote()
A.60
dpPromoteRs()
A.61
dpSet()
A.62
dWfName
A.63
dWfStepName
A.64
EmptyAccountCheckinAllowed
A.65
EnableDocumentHighlight
A.66
encodeHtml()
A.67
entryCount
A.68
eval()
A.69
ExclusiveCheckout
A.70
exec
A.71
executeService()
A.72
ExternalUserAccounts
A.73
ExternalUserRoles
A.74
fieldCaption
A.75
fieldCaptionInclude
A.76
fieldCaptionStyle
A.77
fieldDefault
A.78
fieldEditWidth
A.79
fieldEntryInclude
A.80
fieldExtraScriptInclude
A.81
fieldInclude
A.82
fieldIsOptionList
A.83
fieldMaxLength
A.84
fieldName
A.85
fieldOptionListType
A.86
fieldType
A.87
fieldValue
A.88
fieldValueStyle
A.89
fieldWidth
A.90
fileUrl
A.91
FIRSTREV
A.92
ForcedConversionRules
A.93
forceExpire()
A.94
formatDate()
A.95
formatDateDatabase()
A.96
formatDateDisplay()
A.97
formatDateOnly()
A.98
formatDateOnlyDisplay()
A.99
formatDateOnlyFull()
A.100
formatDateWithPattern()
A.101
formatTimeOnly()
A.102
formatTimeOnlyDisplay()
A.103
GATEWAY_INTERFACE
A.104
generateUniqueId
A.105
getCookie
A.106
GetCopyAccess
A.107
getDebugTrace()
A.108
getErrorTrace()
A.109
getFieldConfigValue
A.110
getFieldViewDisplayValue()
A.111
getFieldViewValue()
A.112
getFreeMemory()
A.113
getHelpPage
A.114
getOptionListSize
A.115
getParentValue()
A.116
getRequiredMsg()
A.117
getTextFile()
A.118
getTotalMemory()
A.119
getUserValue()
A.120
getValue()
A.121
getValueForSpecifiedUser()
A.122
getViewValue()
A.123
getViewValueResultSet()
A.124
hasAppRights()
A.125
HasExternalUsers
A.126
HasLocalCopy
A.127
hasOptionList
A.128
HasOriginal
A.129
HasPredefinedAccounts
A.130
HasUrl
A.131
HeavyClient
A.132
HelpDir
A.133
htmlRefreshTimeout
A.134
htmlRefreshUrl
A.135
HttpAbsoluteCgiPath
A.136
HttpAdminCgiPath
A.137
HttpBrowserFullCgiPath
A.138
HttpCgiPath
A.139
HttpCommonRoot
A.140
HttpEnterpriseCgiPath
A.141
HttpHelpRoot
A.142
HttpImagesRoot
A.143
HttpLayoutRoot
A.144
HttpRelativeAdminRoot
A.145
HttpRelativeWebRoot
A.146
HttpServerAddress
A.147
HttpSharedRoot
A.148
HttpSystemHelpRoot
A.149
HttpWebRoot
A.150
HTTP_ACCEPT
A.151
HTTP_ACCEPT_ENCODING
A.152
HTTP_ACCEPT_LANGUAGE
A.153
HTTP_COOKIE
A.154
HTTP_HOST
A.155
HTTP_INTERNETUSER
A.156
HTTP_REFERER
A.157
HTTP_USER_AGENT
A.158
idocTestForInclude()
A.159
inc()
A.160
incDynamicConversionByRule()
A.161
incGlobal()
A.162
include
A.163
incTemplate()
A.164
indexerSetCollectionValue()
A.165
InstanceDescription
A.166
isActiveTrace()
A.167
isCheckin
A.168
IsCheckinPreAuthed
A.169
isComponentEnabled
A.170
IsContributor
A.171
IsCriteriaSubscription
A.172
IsCurrentNav
A.173
isDocPage
A.174
IsDynamic
A.175
IsDynamicConverterEnabled
A.176
isEditMode
A.177
IsEditRev
A.178
isExcluded
A.179
IsExternalUser
A.180
IsFailedConversion
A.181
IsFailedIndex
A.182
sawflies()
A.183
is Field Excluded
A.184
isFieldHidden
A.185
isFieldInfoOnly
A.186
isFieldMemo
A.187
IsFilePresent
A.188
isFormSubmit
A.189
IsFullTextIndexed
A.190
isHidden
A.191
isInfo
A.192
isInfoOnly
A.193
IsIntranetAuthOnly
A.194
IsJava
A.195
isLayoutEnabled()
A.196
isLinkActive
A.197
IsLocalSearchCollectionID
A.198
IsLoggedIn
A.199
IsMac
A.200
IsMaxRows
A.201
isMultiOption
A.202
IsMultiPage
A.203
isNew
A.204
IsNotLatestRev
A.205
IsNotSyncRev
A.206
IsOverrideFormat
A.207
IsPageDebug
A.208
IsPromptingForLogin
A.209
IsProxiedServer
A.210
isQuery
A.211
isRelocated
A.212
IsRequestError
A.213
isRequired
A.214
IsSavedQuery
A.215
IsSoap
A.216
isStrictList
A.217
IsSubAdmin
A.218
IsSun
A.219
IsSysManager
A.220
isTrue()
A.221
isUpdate
A.222
isUploadFieldScript
A.223
IsUploadSockets
A.224
IsUserEmailPresent
A.225
isUserOverrideSet()
A.226
isValidateFile()
A.227
isVerboseTrace
A.228
IsWindows
A.229
IsWorkflow
A.230
IsXml
A.231
isZoneSearchField
A.232
js()
A.233
jsFilename()
A.234
Json
A.235
lastEntryTs
A.236
lc()
A.237
lcCaption()
A.238
LmDefaultLayout()
A.239
LmDefaultSkin()
A.240
lmGetLayout()
A.241
lmGetSkin()
A.242
loadCollectionInfo()
A.243
loadDocMetaDefinition()
A.244
loadDocumentProfile()
A.245
loadEnterpriseSearchCollections
A.246
loadEnterpriseSearchResults
A.247
loadSchemaData()
A.248
loadSearchOperatorTables()
A.249
loadUserMetaDefinition()
A.250
LocalGroupServer
A.251
localPageType
A.252
MajorRevSeq
A.253
MaxCollectionSize
A.254
maxLength
A.255
MinorRevSeq
A.256
MSIE
A.257
MultiUpload
A.258
NoMatches
A.259
noMCPrefill
A.260
NotificationQuery
A.261
OneMatch
A.262
optionListKey
A.263
optionListName
A.264
optionListResultSet
A.265
optionListScript
A.266
optionListValueInclude
A.267
optionsAllowPreselect
A.268
optList()
A.269
PageParent
A.270
parseDataEntryDate()
A.271
parseDate
A.272
parseDateWithPattern()
A.273
PATH_INFO
A.274
PATH_TRANSLATED
A.275
pneNavigation()
A.276
proxiedBrowserFullCgiWebUrl
A.277
proxiedCgiWebUrl
A.278
QUERY_STRING
A.279
regexMatches()
A.280
regexReplaceAll()
A.281
regexReplaceFirst()
A.282
REMOTE_ADDR
A.283
REMOTE_HOST
A.284
REQUEST_METHOD
A.285
requiredMsg
A.286
ResultsTitle
A.287
rptDisplayMapValue()
A.288
rs()
A.289
rsAddFields()
A.290
rsAddFieldsWithDefaults()
A.291
rsAddRowCountColumn()
A.292
rsAppend()
A.293
rsAppendNewRow()
A.294
rsAppendRowValues()
A.295
rsCopyFiltered()
A.296
rsCreateReference()
A.297
rsCreateResultSet()
A.298
rsDeleteRow()
A.299
rsDocInfoRowAllowDisclosure()
A.300
rsExists()
A.301
rsFieldByIndex()
A.302
rsFieldExists()
A.303
rsFindRowPrimary()
A.304
rsFirst()
A.305
rsInsertNewRow()
A.306
rsIsRowPresent()
A.307
rsLoopInclude()
A.308
rsLoopSingleRowInclude()
A.309
rsMakeFromList()
A.310
rsMakeFromString()
A.311
rsMerge()
A.312
rsMergeDelete()
A.313
rsMergeReplaceOnly()
A.314
rsNext()
A.315
rsNumFields()
A.316
rsNumRows()
A.317
rsRemove()
A.318
rsRename()
A.319
rsRenameField()
A.320
rsSetRow()
A.321
rsSort()
A.322
rsSortTree()
A.323
SafeDir
A.324
SCRIPT_NAME
A.325
SelfRegisteredAccounts
A.326
SelfRegisteredRoles
A.327
SERVER_NAME
A.328
SERVER_PORT
A.329
SERVER_PROTOCOL
A.330
SERVER_SOFTWARE
A.331
setContentType()
A.332
setCookie
A.333
setExpires()
A.334
setHttpHeader()
A.335
setMaxAge()
A.336
setResourceInclude()
A.337
setValue()
A.338
SharedWeblayoutDir
A.339
SingleGroup
A.340
SourceID
A.341
StatusCode
A.342
StatusMessage
A.343
stdSecurityCheck()
A.344
strCenterPad()
A.345
strCommaAppendNoDuplicates()
A.346
strConfine()
A.347
StrConfineOverflowChars
A.348
strEquals()
A.349
strEqualsIgnoreCase()
A.350
strGenerateRandom()
A.351
strIndexOf()
A.352
strLeftFill()
A.353
strLeftPad()
A.354
strLength()
A.355
strLower()
A.356
strRemoveWs()
A.357
strReplace()
A.358
strReplaceIgnoreCase()
A.359
strRightFill()
A.360
strRightPad()
A.361
strSubstring()
A.362
strTrimWs()
A.363
strUpper()
A.364
SysAdminAddress
A.365
TemplateClass
A.366
TemplateFilePath
A.367
TemplateName
A.368
TemplateType
A.369
toInteger()
A.370
trace()
A.371
UploadApplet
A.372
url()
A.373
urlEscape7Bit()
A.374
UseHtmlOrTextHighlightInfo
A.375
UserAccounts
A.376
UserAddress
A.377
UserAppRights
A.378
UserDefaultAccount
A.379
UserFullName
A.380
userHasAccessToAccount()
A.381
userHasGroupPrivilege()
A.382
userHasRole()
A.383
UserIsAdmin
A.384
UserLanguageID
A.385
UserLocaleId
A.386
UserName
A.387
UserRoles
A.388
UseSelfRegistration
A.389
UseSSL
A.390
UseXmlUrl
A.391
utGetValue()
A.392
utLoad()
A.393
utLoadDocumentProfiles()
A.394
utLoadResultSet()
A.395
valueStyle
A.396
WebProxyAdminServer
A.397
wfAction
A.398
wfAddActionHistoryEvent()
A.399
wfAdditionalExitCondition
A.400
wfAddUser()
A.401
wfComputeStepUserList()
A.402
wfCurrentGet()
A.403
wfCurrentSet()
A.404
wfCurrentStep()
A.405
wfDisplayCondition()
A.406
wfExit()
A.407
wfGet()
A.408
wfGetStepTypeLabel
A.409
wfIsFinishedDocConversion()
A.410
wfIsNotificationSuppressed()
A.411
wfIsReleasable()
A.412
wfJumpEntryNotifyOff
A.413
wfJumpMessage
A.414
wfJumpName
A.415
wfJumpReturnStep
A.416
wfJumpTargetStep
A.417
wfLoadDesign()
A.418
wfMailSubject
A.419
wfMessage
A.420
wfNotify()
A.421
wfParentList
A.422
wfReleaseDocument
A.423
wfSet()
A.424
wfSetSuppressNotification()
A.425
WfStart
A.426
wfUpdateMetaData()
A.427
xml()
B
Building a Website
B.1
Planning a Website
B.1.1
The Web Layout
B.1.2
Defining the Site Structure and Displaying Criteria
B.1.3
Task Sequence
B.2
Working with Web Pages
B.3
Managing Web Pages
B.3.1
Adding a New Web Page
B.3.2
Editing Web Page Properties
B.3.3
Creating a Local Page Link
B.3.4
Creating an External URL Link
B.3.5
Editing a Hierarchical Web Page Structure
B.4
Working with Reports
B.4.1
About Reports
B.4.2
Defining an Active Report
B.4.3
Defining a Historical Report
B.4.4
Editing a Query Expression in an Active Report
B.5
Writing Queries
B.5.1
Custom Query Expressions
B.5.2
Creating a Query Link
B.5.3
Editing the Query Expression in a Query Link
B.5.4
Adding a Query Results Page
B.5.5
Editing a Query Results Page
B.5.6
Deleting a Query Results Page
C
Annotations XML Structure
C.1
Changes to Annotations XML Structure
D
Troubleshooting
D.1
About Troubleshooting Aids
D.2
Viewing Server Errors
D.3
Viewing Page Data
D.4
Monitoring Resource Loading
Scripting on this page enhances content navigation, but does not change the content in any way.