Oracle® Fusion Middleware

System Administrator's Guide for Content Server

11g Release 1 (11.1.1)

E10792-01

May 2010

Oracle Fusion Middleware System Administrator's Guide for Content Server, 11g Release 1 (11.1.1)

E10792-01

Copyright © 2010, Oracle and/or its affiliates. All rights reserved.

Primary Author:  Karen Johnson

Contributing Author:  Deanna Burke, Sandra Christiansen, Bruce Silver, Ron van de Crommert, Jean Wilson

Contributor:  Eva Cordes, Ken Jorissen, Alec Kloss, Daniel Lew, Peter Walters, Sam White, Hui Ye

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Contents

Preface

- Audience

- Document Organization

- Documentation Accessibility

- Related Documents

- Conventions

What's New

- New Features for 11g Release 1 (11.1.1)

- Changed Features for 11g Release 1 (11.1.1)

1 Introduction to Oracle Content Server Administration

- 1.1 Understanding Oracle Universal Content Management and Oracle Content Server

- 1.2 Administrative Accounts and Responsibilities

- 1.3 Oracle Content Server Administration Tools

- 1.3.1 Oracle Enterprise Manager Fusion Middleware Control Console

- 1.3.2 Oracle WebLogic Server Administration Console

- 1.3.3 Oracle WebLogic Scripting Tool

- 1.4 Oracle Content Server Administration Utilities and Applets

- 1.4.1 Administration Interfaces

- 1.4.1.1 Utilities

- 1.4.1.2 Management Pages

- 1.4.1.3 Applications

- 1.4.1.4 Command Line

- 1.4.2 Administration Tray

- 1.4.3 Admin Applets Page

- 1.5 Launching Oracle Content Server Administration Applications

- 1.5.1 Running Administration Applications as Applets

- 1.5.2 Running Administration Applications in Standalone Mode

- 1.5.2.1 Configuring System Database Provider for Standalone Mode

- 1.5.2.2 Configuring External Database Provider for Standalone Mode

- 1.5.2.3 Configuring JDBC Database Drivers for Standalone Mode

- 1.5.2.4 Running a Standalone Application on Windows Systems

- 1.5.2.5 Running a Standalone Application on UNIX Systems

2 Using Oracle Fusion Middleware Control to Manage Oracle UCM Content Server

- 2.1 Displaying the Fusion Middleware Control User Interface

- 2.2 Navigating to the Home Page for Oracle UCM Content Server

- 2.3 Starting and Shutting Down Oracle UCM Content Server

- 2.3.1 Starting Oracle UCM Content Server

- 2.3.2 Shutting Down Oracle UCM Content Server

- 2.4 Modifying Configuration Parameters for Oracle UCM Content Server

- 2.4.1 Modifying Server Configuration Parameters for Oracle UCM Content Server

- 2.4.2 Modifying Email Configuration Parameters for Oracle UCM Content Server

- 2.5 Viewing Performance Information for Oracle UCM Content Server

- 2.6 Viewing Log Information for Oracle UCM Content Server

- 2.7 Viewing MBean Information for Oracle UCM Content Server

3 Managing System Settings and Processes

- 3.1 Configuring System Properties

- 3.1.1 About System Properties

- 3.1.2 Configuring General Options

- 3.1.2.1 Revision Label Sequence

- 3.1.2.2 Revision Label Ranges

- 3.1.2.3 Revision Examples

- 3.1.2.4 Revision Configuration Settings

- 3.1.2.5 Chunking Function

- 3.1.2.6 Configuring the Chunking Function

- 3.1.3 Configuring Content Security

- 3.1.4 Configuring Internet Information

- 3.1.5 Configuring the Database

- 3.1.5.1 Configuring Database Driver Settings for Standalone Applications

- 3.1.5.2 Configuring IBM DB2 Database Searches in Content Server

- 3.1.6 Configuring Content Server

- 3.1.7 Configuring Locales

- 3.1.7.1 Date Format

- 3.1.7.2 Interface Language

- 3.1.8 Configuring Paths

- 3.2 Managing Content Server with the Admin Server

- 3.2.1 About the Admin Server

- 3.2.2 Viewing Server Output

- 3.3 Starting, Stopping, and Restarting Content Server

- 3.3.1 Starting Content Server

- 3.3.1.1 Starting Content Server with Oracle WebLogic Server

- 3.3.1.2 Starting Content Server with Oracle WebLogic Scripting Tool Commands

- 3.3.1.3 Starting Content Server with Fusion MIddleware Control

- 3.3.2 Stopping Content Server

- 3.3.2.1 Stopping Content Server with Oracle WebLogic Server

- 3.3.2.2 Stopping Content Server with Oracle WebLogic Scripting Tool Commands

- 3.3.2.3 Stopping Content Server with Fusion MIddleware Control

- 3.3.3 Restarting Content Server

- 3.3.3.1 Restarting Content Server with Oracle WebLogic Server

- 3.3.3.2 Restarting Content Server with Oracle WebLogic Scripting Tool Commands

- 3.3.3.3 Restarting Content Server with Fusion MIddleware Control

- 3.4 Configuring the Search Index

- 3.4.1 Variances in Indexing Tools and Methods

- 3.4.2 Working with the Search Index

- 3.4.2.1 About the Search Index

- 3.4.2.2 Updating the Search Index

- 3.4.2.3 Rebuilding the Collection

- 3.4.2.4 Configuring the Update or Rebuild

- 3.4.2.5 Disabling Full-Text Indexing

- 3.4.3 Text File Full-Text Indexing

- 3.4.4 Managing Zone Text Fields

- 3.4.4.1 About Zone Text Fields

- 3.4.4.2 Enabling and Disabling Zone Text Fields

- 3.4.4.3 Changing the MinTextFullFieldLength Variable

- 3.4.4.4 Disabling Database Search Contains Operator

- 3.4.5 Indexing with Databases

- 3.4.5.1 Database-Supported File Formats

- 3.4.6 Searching Content Using the Oracle Query Optimizer Component

- 3.4.6.1 About The Oracle Query Optimizer Component

- 3.4.6.2 Query Optimization Process

- 3.4.6.3 How Reformatted Queries Optimize Searches

- 3.4.6.4 Types of Recognized Hints

- 3.4.6.5 Query Hints Syntax

- 3.4.6.6 Additional Supported Sort Constructs

- 3.4.6.7 The Hint Rules Table

- 3.4.6.8 Hint Rules Table Column Descriptions

- 3.4.6.9 Hint Rule Editor

- 3.4.6.10 The Hint Cache

- 3.4.6.11 Using Hint Rules

- 3.4.6.12 Using the Query Converter

- 3.4.6.13 Updating the Hint Cache

- 3.5 Configuring a File Store System

- 3.5.1 Introduction to File Store Provider

- 3.5.1.1 Data Management

- 3.5.1.2 File Store Provider Features

- 3.5.2 Configuring File Store Provider

- 3.5.2.1 Using Standard Content Server Variables

- 3.5.2.2 Working with File Store Provider

- 3.5.2.3 Understanding File Store Provider Storage Principles

- 3.5.3 File Store Provider Resource Tables

- 3.5.3.1 PartitionList Table

- 3.5.3.2 StorageRules Table

- 3.5.3.3 PathMetaData Table

- 3.5.3.4 PathConstruction Table

- 3.5.3.5 FileSystemFileStoreAlgorithmFilters Table

- 3.5.3.6 FileStorage Table

- 3.5.3.7 FileCache Table

- 3.5.4 File Store Provider Sample Implementations

- 3.5.4.1 Example PathMetaData Table Options

- 3.5.4.2 Configuration for Standard File Paths

- 3.5.4.3 Configuration for a Webless or Optional Web Store

- 3.5.4.4 Configuration for Database Storage

- 3.5.4.5 Altered Path Construction and Algorithms

- 3.6 Mapping URLs with WebUrlMapPlugin

- 3.6.1 Script Construction

- 3.6.2 Supported Variables for Referencing

- 3.6.3 Add/Edit URL Mapping Entries

- 3.6.4 Mapping Examples

- 3.6.4.1 Info Update Form

- 3.6.4.2 Dynamic Conversion

- 3.6.4.3 CGI parameters

- 3.7 Connecting to Outside Entities with Providers

- 3.7.1 About Providers

- 3.7.1.1 Content Server Providers

- 3.7.1.2 Choosing an Appropriate Provider

- 3.7.1.3 Security Providers

- 3.7.2 Managing Providers

- 3.7.2.1 Adding an Outgoing Provider

- 3.7.2.2 Adding a Database Provider

- 3.7.2.3 Adding an Incoming Provider

- 3.7.2.4 Adding a Preview Provider

- 3.7.2.5 Adding a JPS Provider

- 3.7.2.6 Adding an Incoming Security Provider

- 3.7.2.7 Adding an Outgoing Security Provider

- 3.7.2.8 Editing Provider Information

- 3.7.2.9 Deleting a Provider

- 3.8 Managing Scheduled Jobs

- 3.9 Batchloading Content

- 3.9.1 About Batch Loading

- 3.9.1.1 File Records

- 3.9.1.2 Actions

- 3.9.1.3 Insert

- 3.9.1.4 Delete

- 3.9.1.5 Update

- 3.9.1.6 Optional Parameters

- 3.9.1.7 Custom Metadata Fields

- 3.9.2 Preparing a Batch Load File

- 3.9.2.1 About Preparing a Batch Load File

- 3.9.2.2 Mapping Files

- 3.9.2.3 Creating a Batch Load File from the BatchBuilder Screen

- 3.9.2.4 Creating a Mapping File

- 3.9.2.5 Creating a Batch Load File from the Command Line

- 3.9.3 Running the Batch Loader

- 3.9.3.1 About Running the Batch Loader

- 3.9.3.2 Batch Loading from the Batch Loader Screen

- 3.9.3.3 Batch Loading from the Command Line

- 3.9.3.4 Using the IdcCommand Utility and Remote Access

- 3.9.3.5 Batch Loading Content as Metadata Only

- 3.9.3.6 Batch Loader -console Command Line Switch

- 3.9.3.7 Adding a Redirect

- 3.9.3.8 Correcting Batch Load Errors

- 3.9.4 Optimizing Batch Loader Performance

- 3.9.4.1 Example: Best Practice Case Study

- 3.10 Finding Error and Status Information

- 3.10.1 Log Files

- 3.10.1.1 Log File Characteristics

- 3.10.1.2 Accessing the Log Files

- 3.10.1.3 Using Content Server Logs

- 3.10.1.4 Using Archiver Logs

- 3.10.1.5 Inbound Refinery Logs

- 3.10.2 Configuration Information

- 3.10.3 System Audit Information

- 3.10.3.1 System Audit General Information

- 3.10.3.2 System Audit Localization Information

- 3.10.3.3 System Audit Tracing Sections Information

- 3.10.3.4 System Audit Cache Information

- 3.10.3.5 System Audit Configuration Entry Information

- 3.10.3.6 System Audit Component Report Information

- 3.10.3.7 Server Output Page

- 3.10.3.8 Localization Audit Page

- 3.10.4 Tracing

- 3.10.4.1 Server-Wide Tracing

- 3.10.4.2 Applet-Specific Tracing

- 3.10.5 Environment Packager

- 3.10.6 Content Server Analyzer

- 3.10.7 Using Content Server Analyzer

- 3.10.7.1 Accessing the Content Server Analyzer

- 3.10.7.2 Specifying a Custom Analyzer Log Directory

- 3.10.7.3 Invoking the Analysis Process

- 3.10.7.4 Analyzing the Content Server Database

- 3.10.7.5 Analyzing the Content Server Search Index

- 3.10.7.6 Analyzing the Content Server File System

- 3.10.7.7 Viewing the Analysis Progress and Results

- 3.10.7.8 Generating a Status Report

- 3.10.7.9 Canceling the Status Report

- 3.10.8 Configuration Debug Entry

- 3.10.9 Stack Traces

4 Managing Security and User Access

- 4.1 Introduction to Oracle UCM and Content Server Security

- 4.1.1 Security Features

- 4.1.1.1 Security Integration with Oracle WebLogic Server

- 4.1.1.2 Security within Content Server

- 4.1.1.3 Additional Security Options

- 4.1.2 Types of Users

- 4.1.2.1 External Users

- 4.1.2.2 Local Users

- 4.1.3 Content Server Security Recommendations

- 4.2 Configuring Security for Oracle UCM and Content Server

- 4.2.1 Using an LDAP Authentication Provider

- 4.2.2 Configuring Oracle UCM to Use SSL

- 4.2.2.1 Configuring Oracle UCM for Two-Way SSL Communication

- 4.2.2.2 Invoking References in One-Way SSL Environments in Oracle JDeveloper

- 4.2.2.3 Configuring Oracle ECM Suite, Oracle HTTP Server for SSL Communication

- 4.2.2.4 Switching from Non-SSL to SSL Configurations with Oracle UCM

- 4.2.2.5 Configuring SSL Between Oracle UCM Instances and Oracle WebCache

- 4.2.2.6 Using a Custom Trust Store for One-Way SSL During Design Time

- 4.2.2.7 Enabling an Asynchronous Process to Invoke Another Asynchronous Process

- 4.2.2.8 Configuring RIDC SSL for Valid Certificate Path

- 4.2.3 Configuring Oracle UCM to Use Single Sign-On

- 4.2.3.1 Configuring Oracle Access Manager (OAM)

- 4.2.3.2 Configuring Oracle Single Sign-On for Oracle UCM

- 4.2.3.3 Configuring SSO with Microsoft Clients

- 4.2.4 Configuring OID as the First Authentication Provider

- 4.2.5 Configuring Oracle WebLogic Server Web Services

- 4.2.6 Additional Security Configuration Documentation

- 4.3 Security Groups, Roles, and Permissions

- 4.3.1 Introduction to Security Groups

- 4.3.1.1 Best Practices for Working with Security Groups

- 4.3.1.2 Performance Considerations

- 4.3.2 Managing Groups on Content Server

- 4.3.2.1 Adding a Security Group on Content Server

- 4.3.2.2 Deleting a Security Group on Content Server

- 4.3.3 Introduction to Roles and Permissions

- 4.3.3.1 Predefined Roles

- 4.3.3.2 About Permissions

- 4.3.3.3 Predefined Permissions

- 4.3.4 Managing Roles and Permissions on Content Server

- 4.3.4.1 Creating a Role on Content Server

- 4.3.4.2 Deleting a Role on Content Server

- 4.3.4.3 Assigning Roles to a User on Oracle WebLogic Server

- 4.3.4.4 Assigning Roles to Create Similar Users on Oracle WebLogic Server

- 4.3.4.5 Adding and Editing Permissions on Content Server

- 4.4 Accounts

- 4.4.1 Introduction to Accounts

- 4.4.1.1 Accounts and Security Groups

- 4.4.1.2 Hierarchical Accounts

- 4.4.1.3 Performance Considerations

- 4.4.1.4 External Directory Server Considerations

- 4.4.2 Managing Accounts

- 4.4.2.1 Enabling Accounts on Content Server

- 4.4.2.2 Creating Predefined Accounts on Content Server

- 4.4.2.3 Creating Accounts When Checking In Content on Content Server

- 4.4.2.4 Deleting Predefined Accounts on Content Server

- 4.4.2.5 Assigning Accounts to a User on Oracle WebLogic Server

- 4.4.3 An Accounts Case Study

- 4.4.3.1 Xalco Security

- 4.4.3.2 Xalco Accounts

- 4.4.3.3 Xalco Roles

- 4.4.3.4 Roles and Permissions Table

- 4.4.3.5 Roles and Users Table

- 4.4.3.6 Accounts and Users Table

- 4.5 User Logins and Aliases

- 4.5.1 Introduction to User Logins and Aliases

- 4.5.2 Managing Logins and Aliases

- 4.5.2.1 Adding a User Login

- 4.5.2.2 Editing a User Login

- 4.5.2.3 Deleting a User Login

- 4.5.2.4 Creating an Alias

- 4.5.2.5 Editing an Alias

- 4.5.2.6 Deleting an Alias

- 4.5.3 User Information Fields

- 4.5.3.1 About User Information Fields

- 4.5.3.2 Managing User Information Fields

- 4.6 Security and Content Server Providers

- 4.7 Additional Content Server Security Connections

- 4.7.1 About Proxy Connections

- 4.7.2 Credentials Mapping

- 4.7.2.1 About Credentials Mapping

- 4.7.2.2 Credential Values

- 4.7.2.3 Matching Accounts and Roles

- 4.7.2.4 Creating a Credentials Map

- 4.7.3 Secured Connections to Content Servers

- 4.7.3.1 About Named Password Connections

- 4.7.3.2 Guidelines for Proxy Connections Data

- 4.7.3.3 Creating a Proxied Connection

- 4.7.4 Connections Using the HTTP Protocol

- 4.7.4.1 About Using HTTP Protocol for Content Server Connection

- 4.7.4.2 Configuring the HTTP Provider

- 4.8 Content Server Communication Customization

- 4.8.1 Login/Logout Customization

- 4.8.2 Browser URL Customization

- 4.8.2.1 About BrowserUrlPath Customization

- 4.8.2.2 Affected Idoc Script Variables and Functions

- 4.8.2.3 Determining the URL Path

- 4.8.2.4 Changing Absolute Full Path Computation

- 4.8.2.5 Changing Administration Path Computation

- 4.8.3 Extended User Attributes

- 4.8.3.1 ExtUserAttribInfo ResultSet

- 4.8.3.2 Configuration Variable for Extended User Attributes

- 4.8.4 Filter Data Input

- 4.8.4.1 encodeHtml Function

- 4.8.4.2 HtmlDataInputFilterLevel Configuration Variable

5 Working With Components

- 5.1 About Components

- 5.2 Using the Component Manager

- 5.2.1 Enabling and Disabling a Component

- 5.2.2 Viewing Information about a Component

- 5.2.3 Uploading a Component

- 5.2.4 Downloading a Component

- 5.3 Using the Component Wizard

- 5.3.1 Component Wizard Overview

- 5.3.1.1 Working with Java Code

- 5.3.1.2 Editing the Readme File

- 5.3.2 Creating a Component

- 5.3.2.1 Creating an Environment Resource

- 5.3.2.2 Creating a Template Resource

- 5.3.2.3 Creating a Query Resource

- 5.3.2.4 Creating a Service Resource

- 5.3.2.5 Creating an HTML Include

- 5.3.2.6 Creating a String Resource

- 5.3.2.7 Creating a Dynamic Table Resource

- 5.3.2.8 Creating a Static Table Resource

- 5.3.2.9 Enabling the Component

- 5.3.3 Additional Component Wizard Tasks

- 5.3.3.1 Building a Component Zip File

- 5.3.3.2 Working With Installation Parameters

- 5.3.3.3 Enabling and Disabling a Component

- 5.3.3.4 Removing a Component

- 5.3.3.5 Opening a Component

- 5.3.3.6 Configuring the Default HTML Editor

- 5.3.3.7 Unpackaging a Component

- 5.3.3.8 Adding an Existing Component

- 5.4 Using the Command Line

6 Managing Search Tools

- 6.1 OracleTextSearch

- 6.1.1 Considerations

- 6.1.2 Configuring OracleTextSearch for Content Server

- 6.1.3 Benefits and Features of Using Oracle Text 11g

- 6.1.3.1 Indexing and Query Speeds and Techniques

- 6.1.3.2 Fast Rebuild

- 6.1.3.3 Query Syntax

- 6.1.3.4 Search Operators

- 6.1.3.5 Case Sensitivity and Stemming Rules

- 6.1.3.6 Search Results Data Clustering

- 6.1.3.7 Snippets

- 6.1.3.8 Additional Changes

- 6.1.4 Managing OracleTextSearch

- 6.1.4.1 Determining Fields to Optimize

- 6.1.4.2 Assigning/Editing Optimized Fields

- 6.1.4.3 Performing a Fast Rebuild

- 6.1.4.4 Modifying the Fields Displayed on Search Results

- 6.1.5 Searching with OracleTextSearch

- 6.1.6 Search Results with OracleTextSearch

- 6.2 Oracle Secure Enterprise Search

- 6.2.1 Configuring Oracle SES and Oracle UCM

7 Managing System Migration and Archiving

- 7.1 Introduction to Migration Tools and Components

- 7.2 Archiving Overview

- 7.2.1 Configuration Migration

- 7.2.2 Archiver

- 7.2.3 Folder Archiving

- 7.2.4 FolderStructureArchive Component

- 7.2.5 ArchiveReplicationExceptions

- 7.2.6 Archive Tool Summary and Comparison

- 7.2.7 Running the Archiver as a Standalone Application

- 7.3 Migrating System Configurations

- 7.3.1 Configuration Migration Utility Details

- 7.3.1.1 Migration Structure

- 7.3.1.2 About Migration Templates and Bundles

- 7.3.2 Migration Tips

- 7.3.2.1 Limitations

- 7.3.2.2 Migration Logs

- 7.3.3 Managing Configuration Migration

- 7.3.3.1 Creating a Configuration Migration Template

- 7.3.3.2 Editing a Configuration Template

- 7.3.3.3 Importing a Template

- 7.3.3.4 Creating a One-Time Export

- 7.3.3.5 Exporting a Configuration

- 7.3.3.6 Uploading a Bundle

- 7.3.3.7 Importing a Bundle

- 7.3.3.8 Downloading a Bundle

- 7.3.3.9 Viewing Status Information

- 7.4 Archives, Collections and Batch Files

- 7.4.1 Archive Details

- 7.4.1.1 Archive Structure

- 7.4.1.2 Collections

- 7.4.1.3 Batch Files

- 7.4.1.4 Archive Targets

- 7.4.1.5 Using Archive Logs

- 7.4.2 Managing Archives

- 7.4.2.1 Creating a New Archive

- 7.4.2.2 Copying an Existing Archive

- 7.4.2.3 Creating a New Archive by Copying

- 7.4.2.4 Deleting an Archive

- 7.4.3 Managing Collections

- 7.4.3.1 Opening a Collection

- 7.4.3.2 Creating a Collection

- 7.4.3.3 Removing a Collection

- 7.4.3.4 Moving the Default Archive Collection

- 7.4.4 Managing Batch Files

- 7.4.4.1 Removing Revisions from a Batch File

- 7.4.4.2 Deleting a Batch File

- 7.5 Exporting Data in Archives

- 7.5.1 About Exporting

- 7.5.1.1 Export Uses

- 7.5.1.2 Export Methods

- 7.5.2 Managing Exports

- 7.5.2.1 Manually Exporting

- 7.5.2.2 Creating a Content Item Export Query

- 7.5.2.3 Exporting Configuration Information

- 7.5.2.4 Adding a Table to an Archive

- 7.5.2.5 Editing the Archive Properties of a Table

- 7.5.2.6 Creating a Table Export Query

- 7.5.2.7 Setting Export Options

- 7.5.2.8 Initiating the Export

- 7.6 Importing Data

- 7.6.1 Imported Files

- 7.6.1.1 Import Uses

- 7.6.1.2 Import Methods

- 7.6.2 Import Rules

- 7.6.2.1 Update Import Rule

- 7.6.2.2 Insert Revision Import Rule

- 7.6.2.3 Insert Create Import Rule

- 7.6.2.4 Delete Revision Import Rule

- 7.6.2.5 Delete All Revisions Import Rule

- 7.6.3 Import Process

- 7.6.3.1 Importing Archived Data Manually

- 7.6.3.2 Setting Field Maps

- 7.6.3.3 Setting Value Maps

- 7.6.3.4 Setting Import Options

- 7.6.3.5 Importing an Individual Revision

- 7.6.3.6 Initiating the Import

- 7.7 Transferring Files

- 7.7.1 File Transfer Overview

- 7.7.1.1 Transfer Uses

- 7.7.1.2 Transfer Methods

- 7.7.1.3 Transfer Terms

- 7.7.2 Transfer Types

- 7.7.2.1 Local Transfer

- 7.7.2.2 Pull Transfer

- 7.7.2.3 Push Transfer

- 7.7.3 Transferring Batch Files

- 7.7.4 Managing Transfers

- 7.7.4.1 Transfer Process

- 7.7.4.2 Making an Archive Targetable

- 7.7.4.3 Defining an Outgoing Transfer Provider

- 7.7.4.4 Setting a Transfer Destination (Target)

- 7.7.4.5 Initiating a Manual Transfer

- 7.7.4.6 Deleting a Transfer

- 7.8 Replicating Files

- 7.8.1 Replication Overview

- 7.8.1.1 Single Revision Replications

- 7.8.1.2 Replication Uses

- 7.8.1.3 Replication Methods

- 7.8.2 Managing Replication

- 7.8.2.1 Setting Up Automatic Export

- 7.8.2.2 Setting Up Automatic Import

- 7.8.2.3 Setting Up Automatic Transfer

- 7.8.2.4 Disabling Automatic Import

- 7.8.2.5 Disabling Automatic Export

- 7.8.2.6 Disabling Automatic Transfer

- 7.8.2.7 Deleting a Registered Exporter

- 7.9 Archive and Migration Strategies

- 7.9.1 Export

- 7.9.2 Import

- 7.9.3 Self Export/Import

- 7.9.4 One-to-One Archiving

- 7.9.5 One-to-Many Archiving

- 7.9.6 Many-to-One Archiving

- 7.9.7 Archiver Examples

- 7.9.7.1 Copying a Content Server Instance to a Laptop

- 7.9.7.2 Transferring by Content Type and Author

- 7.9.7.3 Changing Metadata Fields

- 7.9.7.4 Adding Content ID Prefixes

- 7.9.7.5 Changing Release Dates

- 7.9.8 Configuration Migration Tips

- 7.10 Folder Archiving

- 7.10.1 Folder Archive Functions

- 7.10.2 Exporting an Archived Folder Structure

- 7.10.3 Importing an Archived Folder Structure

- 7.11 Folder Structure Archiving

- 7.11.1 Overview of Folder Structure Archive

- 7.11.2 Differences With Built-in Folders Archiving Features

- 7.11.3 Working With Folder Structure Archives

- 7.11.3.1 Creating a Folder Structure Archive

- 7.11.3.2 Updating a Folder Structure Archive

- 7.11.3.3 Using a Folder Structure Archive

- 7.11.3.4 Configuration Variables

- 7.11.4 Important Implementation Considerations

- 7.12 Archiver Replication Exceptions

- 7.12.1 Overview of ArchiverReplicationExceptions

- 7.12.1.1 How ArchiverReplicationExceptions Works

- 7.12.1.2 Scenario 1

- 7.12.1.3 Scenario 2

- 7.12.2 Administering and Using ArchiverReplicationExceptions

- 7.13 Troubleshooting Archiving Issues

- 7.13.1 Importing Issues

- 7.13.1.1 File Extension Errors on Import Machine

- 7.13.1.2 Selecting Specific Batch Files for Import

- 7.13.1.3 Import Maps Do Not Work After Archive Import

- 7.13.1.4 Identifying Imported Content Items From Archive

- 7.13.1.5 Duplicate Content Items in Content Servers

- 7.13.1.6 Importing Archived Content to Proxied Server Fails

- 7.13.1.7 No Importing Errors But Documents Are Missing

- 7.13.1.8 Errors About Invalid Choice List Values

- 7.13.1.9 Import Fails Due to Missing Required Field

- 7.13.1.10 Changed Metadata Field Makes the Archiver Freeze During an Import

- 7.13.2 Exporting Issues

- 7.13.2.1 Total Export Possible with Blank Export Query

- 7.13.2.2 New Check-Ins and Batch File Transfers

- 7.13.2.3 Exporting User Attributes

- 7.13.2.4 Folder Archive Export Doesn't Work If Collections Table Has Many Records

- 7.13.3 Transfer Issues

- 7.13.3.1 Transfer Stopped When Target Locked Up

- 7.13.3.2 Aborting/Deleting a Running Transfer

- 7.13.3.3 Verifying the Integrity of Transferred Files

- 7.13.3.4 Transfer Process Is Not Working

- 7.13.4 WebDAV Issues

- 7.13.4.1 Archiver Error With WebDAV and Content Server

- 7.13.5 Replication Issues

- 7.13.5.1 Stopping the Automatic Import Function

- 7.13.6 Oracle-Specific Issues

- 7.13.6.1 Allotted Tablespace Exceeded

- 7.13.7 Miscellaneous Issues

- 7.13.7.1 Archiving Does Not Work With Shared File System

- 7.13.7.2 Archiving Does Not Work Over Outgoing Provider

A User Interface

- A.1 System Properties and Settings Interface

- A.1.1 Admin Server Interface

- A.1.1.1 Admin Server Page

- A.1.1.2 Admin Server Status Page

- A.1.1.3 Admin Server Output Page

- A.1.1.4 Administration Page

- A.1.2 System Properties Configuration Interface

- A.1.2.1 System Properties Page

- A.1.2.2 General Options Configuration

- A.1.2.3 Content Security Configuration

- A.1.2.4 Internet Information Configuration

- A.1.2.5 System Properties: Database Tab

- A.1.2.6 System Properties: Server Tab

- A.1.2.7 System Properties: Paths Tab

- A.1.3 Indexing and Search Content Interface

- A.1.3.1 Repository Manager: Indexer Tab

- A.1.3.2 Automatic Update Cycle Screen

- A.1.3.3 Collection Rebuild Cycle Screen

- A.1.3.4 Indexer Rebuild Screen

- A.1.3.5 Oracle Query Optimizer Page

- A.1.3.6 Zone Fields Configuration Page

- A.1.3.7 Hint Rules Configuration Page

- A.1.3.8 Edit Query Hint Rules Table

- A.1.3.9 Query Converter Page

- A.1.3.10 Hint Cache Updater Page

- A.1.3.11 Admin Actions Page

- A.1.4 File Store Administration Interface

- A.1.4.1 Partition Listing Page

- A.1.4.2 Add/Edit Partition Page

- A.1.4.3 FileStore Provider Information Page

- A.1.4.4 Edit File Store Provider Page

- A.1.4.5 Add/Edit Storage Rule Page

- A.1.4.6 Path Information Screen

- A.1.5 Web Server Interface Screens

- A.1.5.1 Configure Web Server Filter Page

- A.1.5.2 WebUrlMaps Screen

- A.1.6 Provider Interface

- A.1.6.1 Providers Page

- A.1.6.2 Provider Information Page

- A.1.6.3 Add/Edit Provider Page

- A.1.6.4 Outgoing Provider Page

- A.1.6.5 Database Provider Page

- A.1.6.6 Incoming Provider Page

- A.1.6.7 Preview Provider Page

- A.1.6.8 LDAP Provider Page

- A.1.6.9 keepaliveincoming Provider Page

- A.1.6.10 keepaliveoutgoing Provider Page

- A.1.6.11 sslincoming Provider Page

- A.1.6.12 ssloutgoing Provider Page

- A.1.6.13 JPS User Provider Page

- A.1.6.14 Outgoing Http Provider Page

- A.1.7 Scheduled Jobs Administration Interface

- A.1.7.1 Active Scheduled Jobs Screen

- A.1.7.2 Scheduled Jobs History

- A.1.7.3 Scheduled Jobs Information Screen

- A.1.8 Batch Interface Screens

- A.1.8.1 Batch Loader Application

- A.1.8.2 BatchBuilder Screen

- A.1.8.3 BatchBuilder Mapping List Screen

- A.1.8.4 Add BatchBuilder Mapping Screen

- A.1.8.5 Edit BatchBuilder Mapping Screen

- A.1.8.6 Add/Edit BatchBuilder Mapping Field Screen

- A.1.9 Content Server Analyzer Interface

- A.1.9.1 Content Server Analyzer: Configuration Tab

- A.1.9.2 Content Server Analyzer: Progress Tab

- A.1.10 Error and Status Information Interface

- A.1.10.1 Content Server Logs Screen

- A.1.10.2 Archiver Log Screen

- A.1.10.3 Database Log Screen

- A.1.10.4 Configuration Information Page

- A.1.10.5 System Audit Information Page

- A.1.10.6 Environment Packager Page

- A.2 Security and User Access Interface

- A.2.1 Security Administration Interface

- A.2.1.1 User Admin Screen

- A.2.1.2 Define Filter Screen

- A.2.1.3 Show Columns Screen

- A.2.2 Groups, Roles, and Permissions Interface

- A.2.2.1 Permissions By Group Screen

- A.2.2.2 Add New Group Screen

- A.2.2.3 Permissions By Role Screen

- A.2.2.4 Add New Role Screen

- A.2.2.5 Edit Permissions Screen

- A.2.3 Accounts Interface

- A.2.3.1 Predefined Accounts Screen

- A.2.3.2 Add New Predefined Account Screen

- A.2.3.3 Add/Edit Account Permissions Screen

- A.2.4 User Login and Alias Interface

- A.2.4.1 User Admin Screen: Users Tab

- A.2.4.2 Choose/Change the Authorization Type Screen

- A.2.4.3 Add/Edit User Screen

- A.2.4.4 Add/Edit User Screen: Info Tab (Local User)

- A.2.4.5 Add/Edit User Screen: Info Tab (Global User)

- A.2.4.6 Add/Edit User Screen: Roles Tab

- A.2.4.7 Add Role Screen

- A.2.4.8 Add/Edit User Screen: Accounts Tab

- A.2.4.9 Option List Screen

- A.2.4.10 User Admin Screen: Aliases Tab

- A.2.4.11 Add New Alias/Edit Alias Screen

- A.2.4.12 Select Users Screen

- A.2.4.13 Sub-Administration Interface: Edit Rights Screen

- A.2.4.14 User Admin Screen: Information Fields Tab

- A.2.4.15 Add Metadata Field Name Screen

- A.2.4.16 Edit Metadata Field Screen

- A.2.4.17 Update Database Design Screen

- A.2.5 Proxy Connections Interface

- A.2.5.1 Credential Maps Screen

- A.2.5.2 Proxied Connection Authentication/Authorization Information Screen

- A.3 Components Interface

- A.3.1 Component List Screen

- A.3.2 Component Wizard Main Screen

- A.3.2.1 Options Menu

- A.3.2.2 Build Menu

- A.3.2.3 Help Menu

- A.3.3 Component Creation Screens

- A.3.3.1 Add Component Screen

- A.3.3.2 Install Screen

- A.3.3.3 Component Configuration Screen

- A.3.3.4 Add/Edit Action Screen

- A.3.3.5 Add Screen

- A.3.3.6 Add Query Table Information Screen

- A.3.3.7 Add Service Table Information Screen

- A.3.3.8 Add Dynamic Resource Table Information Screen

- A.3.3.9 Add Static Resource Table Information Screen

- A.3.3.10 Add Template Table Information Screen

- A.3.3.11 Add/Edit HTML Resource Include/String Screen

- A.3.3.12 Add/Edit Parameter Screen

- A.3.3.13 Add/Edit Query Screen

- A.3.3.14 Add Resource Screen

- A.3.3.15 Resource Selection Dialog Screen

- A.3.3.16 Add/Edit Service Screen

- A.3.3.17 Preview Information for Service Screen

- A.3.3.18 Preview Action Information Screen

- A.3.3.19 Add/Edit SearchResults Template Screen

- A.3.3.20 Column Information Screen

- A.3.3.21 Add/Edit Intradoc Template Screen

- A.3.3.22 Add/Edit Preference Screen

- A.3.4 Build Screens

- A.3.4.1 Install/Uninstall Settings Tab

- A.3.4.2 Main Build Screen

- A.3.4.3 Build Settings Screen

- A.3.4.4 Advanced Build Settings Screen

- A.3.4.5 Advanced Build Settings Review Screen

- A.3.5 Component Manager Page

- A.3.6 Advanced Component Manager Page

- A.4 System Migration Interface

- A.4.1 Configuration Migration Interface Screens

- A.4.1.1 Migration Options

- A.4.1.2 Upload Configuration Bundle Screen

- A.4.1.3 Configuration Bundles Page

- A.4.1.4 Configuration Templates Page

- A.4.1.5 Config Migration Admin Screen

- A.4.1.6 Content Server Sections

- A.4.1.7 Preview Screen

- A.4.1.8 Edit Export Rule Screen

- A.4.1.9 Latest Action Screen

- A.4.1.10 Action History Page

- A.4.2 Archive, Collection, and Batch Interface

- A.4.2.1 Main Archiver Screen

- A.4.2.2 Archiver (General Tab)

- A.4.2.3 Add Archive Screen

- A.4.2.4 Copy Archive Screen

- A.4.2.5 Open Archive Collection Screen

- A.4.2.6 Find Archive Collection Definition File Screen

- A.4.2.7 Browse To Archiver Collection Screen

- A.4.2.8 Browse for Proxied Collection Screen

- A.4.2.9 View Batch Files Screen

- A.4.2.10 View Exported Content Items Screen

- A.4.3 Export Interface Screens

- A.4.3.1 Main Archiver Export Screen

- A.4.3.2 Export Data (Content) Screen

- A.4.3.3 Edit Export Query (Content) Screen

- A.4.3.4 Edit Export Options Screen

- A.4.3.5 Previewing Export Queries (Content) Screen

- A.4.3.6 Main Archiver Export Screen (Table)

- A.4.3.7 Add New/Edit Table Screen

- A.4.3.8 Edit Export Query (Table) Screen

- A.4.3.9 Previewing Export Queries (Table) Screen

- A.4.3.10 Export Archive Screen

- A.4.4 Import Interface Screens

- A.4.4.1 Import Maps Main Screen

- A.4.4.2 Import Maps (Content) Screen

- A.4.4.3 Edit Field Map/Edit Value Map Screen

- A.4.4.4 Browse for Fields/Value Screen

- A.4.4.5 Import Maps (Table) Screen

- A.4.4.6 Edit Archive Properties on Table Screen

- A.4.4.7 Edit Import Options (Select Rules) Screen

- A.4.4.8 Import Archive Screen

- A.4.5 Replication Interface Screens

- A.4.5.1 Main Archiver Replication Screen

- A.4.5.2 Registered Exporter Screen

- A.4.5.3 Automation (Exporters) Screen

- A.4.5.4 Automation (Importers) Screen

- A.4.5.5 Automation (Transfers) Screen

- A.4.5.6 Automation (Queries) Screen

- A.4.6 Transfer Interface Screens

- A.4.6.1 Main Archiver Transfer Screen

- A.4.6.2 Transfer Options Screen

- A.4.6.3 Archive Collections Screen

- A.4.7 Folder Archive Configuration Page

B Need to Know Component

- B.1 Introduction

- B.1.1 Features

- B.1.2 Applications

- B.2 Installing the NTK Component

- B.3 Configuring the NTK Component

- B.4 Using the Need To Know Component

- B.4.1 Security Configuration Customization

- B.4.1.1 Content Security

- B.4.1.2 Search Results

- B.4.1.3 Hit List Roles

- B.4.1.4 WHERE Clause Calculation

- B.4.1.5 Content Metadata Security

- B.4.2 Disclosure Query Security Applet

- B.4.3 Query Syntax

- B.4.3.1 Like Operator

- B.4.3.2 Boolean Operators

- B.4.3.3 UserName Variable

- B.4.3.4 stdSecurity Variable

- B.4.3.5 User Attribute Fields

- B.4.3.6 User Roles

- B.4.4 Defining a Content-Level Query

- B.5 NTK Administration Interface

- B.5.1 NTK Configuration Information Page

- B.5.2 Content Security Configuration Information Page

- B.5.3 Search Results Configuration Information Page

- B.5.4 Hit List Roles Configuration Information Page

- B.5.5 Test NTK Content Security Page

- B.6 Security Customization Samples

- B.6.1 Content Security Samples

- B.6.1.1 Simple Idoc Script Function

- B.6.1.2 Using stdSecurityCheck

- B.6.1.3 Using isStrIntersect

- B.6.1.4 Using allStrIntersect

- B.6.1.5 Using includeNTKReadSecurityScript

- B.6.2 Search Result Samples

- B.6.2.1 Disabling Links

- B.6.2.2 Changing Links

- B.6.2.3 Changing Images

- B.6.3 Hit List Roles Samples

- B.6.3.1 Using the Query Hit List Role

- B.6.3.2 Creating a Black Hole Check In

Index

Preface

This guide describes concepts and tasks for configuring and managing the Oracle Content Server system.

Audience

This guide is intended for people who are responsible for configuring and administering Content Server.

Document Organization

This guide includes the following sections:

- Chapter 1, "Introduction to Oracle Content Server Administration," provides an overview of Content Server administration tasks, Oracle Enterprise Manager Fusion Middleware Control, Oracle WebLogic Server Administration Console, Oracle WebLogic Scripting Tool, the Content Server Administration page and utilities, and how to run Content Server administration applications.

- Chapter 2, "Using Oracle Fusion Middleware Control to Manage Oracle UCM Content Server", provides information on using Fusion Middleware Control to access UCM Content Server and manage certain Content Server tasks and configuration.

- Chapter 3, "Managing System Settings and Processes," provides information on configuring and managing Content Server using system settings and processes.

- Chapter 4, "Managing Security and User Access," provides information on managing content security, user access, and network security for Content Server.

- Chapter 5, "Working With Components," provides information on adding, removing, and managing components, which provide additional specialized functionality.

- Chapter 6, " Managing Search Tools," provides information on using Oracle Text Search to search content.

- Chapter 7, "Managing System Migration and Archiving," provides instructions for the tasks needed to migrate both the content and structure of one Content Server to another.

- Appendix A, "User Interface," contains reference information on the graphical user interface screens used for administration functions and tasks.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. 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/.

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/support/contact.html or visit http://www.oracle.com/accessibility/support.html if you are hearing impaired.

Related Documents

For more information, see the following documents in the Oracle Fusion Middleware Content Server 11g Release 1 (11.1.1) documentation set:

- Oracle Fusion Middleware Content Server Release Notes

- Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite

- Oracle Fusion Middleware Developer's Guide for Content Server

- Oracle Fusion Middleware Application Administrator's Guide for Content Server

Conventions

The following text conventions are used in this document:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

Slash (/)

A slash is used to separate the directory levels in a path to a UNIX server, directory, or file. Slashes are also used to separate parts of an Internet address. A slash will always be included at the end of a UNIX directory name and might or might not be included at the end of an Internet address.

Backward slash (\)

A backward slash is used to separate the levels in a path to a Windows server, directory, or file. A backward slash will always be included at the end of a Windows server, directory, or file path.

What's New

This preface introduces the new and changed features of Oracle Universal Content Management (Oracle UCM) Content Server system administration that are described in this guide.

New Features for 11g Release 1 (11.1.1)

11g Release 1 (11.1.1) includes the following new features in this guide:

- This guide combines information that was previously contained in the following Content Server version 10g documents:

- Managing Enterprise Search

- Managing Security and User Access

- Managing System Migration

- Managing System Settings and Processes

- System Overview

- Working with Components

- Need to Know Component Installation and Administration Guide

It includes a new chapter on using Oracle Enterprise Manager Fusion Middleware Control to manage Content Server configuration.

- Content Server is deployed on an Oracle WebLogic Server, which causes several changes in Oracle Universal Content Management (Oracle UCM).

- Using the Oracle Enterprise Manager Fusion Middleware Control: Some Oracle UCM Content Server functions can be managed with the Fusion Middleware Control user interface, including starting and stopping the server, modifying certain server and email configuration parameters, viewing log information, and viewing performance information.

- Connecting to the System Database: Oracle UCM uses an Oracle WebLogic Server data source to communicate with the relational database where metadata and other information is stored. Database connection and communication information is managed with the Oracle WebLogic Server Administration Console, as opposed to Content Server's System Properties utility. As a result, JDBC username and password information are no longer stored in the Content Server's config.cfg file.

- Running Administration Utilities as Standalone Applications: In order to run Content Server standalone applications or administration utilities in standalone mode (that is, from the command line or from the Windows Start menu), database connection information must be entered into the Content Server's config.cfg file. The administrator must run the System Properties utility to enter database connection information (database type, database user name, database user password, and so forth) in the config file. Unless this configuration is performed, the Content Server standalone applications and utilities cannot function in standalone mode because they cannot connect to the database. Only the administrator or an assigned local user (created on Content Server) can run Admin Applets in standalone mode

- Database Connection Pooling and Management: Oracle UCM uses the Oracle WebLogic Server database connection pooling mechanism to handle database communication. The SystemDatabase Provider is still present and uses the Oracle WebLogic Server data source, which in turn handles the actual database authentication and communication.

- Default User Provider: The JpsUserProvider is the default user provider for communication with Oracle WebLogic Server.

- Database Providers: Oracle UCM administrators can still create database providers in the Content Server in one of two ways. Using one method, the administrator can create an Oracle WebLogic Server data source to the database, then configure a Content Server database provider to use that data source. The other method is for the administrator to create a Content Server database provider to connect directly to the database with JDBC without using the Oracle WebLogic Server data source. This second method is provided primarily for sites who may have such connections in Release 10gR3 deployments and are upgrading.

- Admin Server: With Oracle UCM, each Content Server instance must have one Admin Server instance. An Admin Server can only manage the Content Server instance that is installed on the same Oracle WebLogic Server domain. The Admin Server no longer supports server starts, stops, or restarts, but it does continue to support configuration changes, status information, and logs. Stopping and starting Content Server must be managed with the Enterprise Manager Fusion Middleware Control Console, or the Oracle WebLogic Server Administration Console.

- Proxy Servers and Master Servers: Oracle UCM does not support proxied Content Server instances. Only one Content Server can be deployed on each Oracle WebLogic Server domain. A single Oracle WebLogic Server domain can run one Content Server instance, one Inbound Refinery instance, and one Universal Records Management instance, and other Fusion Middleware applications. If you want to run more instances, a separate Oracle WebLogic Server domain is required for another Content Server instance, Inbound Refinery instance, or Universal Records Management instance.

- Content Server Port: After initial installation of the Content Server, the Content Server does not listen on any port. After the IntradocServerPort parameter is set on the post-configuration page, Content Server starts listening on the specified port.

- HTTP and HTTPS: By default, Oracle UCM is accessible with both HTTP and HTTPS. You can configure access methods with the Oracle WebLogic Server Administration Console.

- User Administration: Oracle UCM uses Oracle WebLogic Server to manage users for Content Server, which involves several changes.

- Oracle UCM uses the Oracle WebLogic Server user store to manage user names and passwords. User management tasks must be performed with Oracle WebLogic Server user management tools as opposed to the User Admin applet in Content Server. The JpsUserProvider is installed by default to communicate with the Oracle WebLogic Server user store for authentication and authorization purposes.

- The Oracle WebLogic Server has limited capabilities to manage user metadata. User attribute values set in the Oracle WebLogic Server user store can be mapped to Content Server user metadata by editing the JpsUserProvider.

- All user authentications are done against the Oracle WebLogic Server user store. Oracle WebLogic Server does not authenticate users against the Content Server user store. Although the Content Server User Admin applet allows you to create users and assign passwords, the users are not able to login to the Content Server unless the users have also been created and assigned passwords on Oracle WebLogic Server.

- In the Oracle WebLogic Server user store, users can be assigned to groups. When a user logs in to Content Server, the user is authenticated against the Oracle WebLogic Server user store via the JPS provider and the user's groups are mapped to Content Server roles and accounts. All Oracle WebLogic Server groups assigned to the user are mapped over as roles in Content Server, except for groups that start with “@,” which are mapped to Content Server accounts.

- Roles and security groups still must be created in the Content Server with the User Admin applet, but roles-to-security group assignments must be performed with Oracle WebLogic Server. For Oracle WebLogic Server groups to have meaning in Content Server, roles with the exact same names must be created in Content Server and assigned to security groups. If this is not done, the groups assigned to the user have no effect on user privileges in Content Server.

- The following information is new for managing system settings and processes:

- File Store System: A file store system for data management replaces the traditional file system for storing and organizing content. File Store Provider exposes the file store functionality in the Content Server interface, and allows additional configuration options. The File Store Provider component is installed and enabled by default with Content Server installation. See "Configuring a File Store System".

- The following information is new for managing security and user access:

- Extended User Attributes: The Extended User Attributes component enables administrators to add extended attributes to Content Server users. The extended attributes are merged into pre-existing user attributes and enable additional flexibility in managing users. The Extended User Attributes component is installed and enabled by default with Content Server. See "Extended User Attributes".

- The following information is new for managing search tools:

- Oracle SES Configuration: Oracle Universal Content Management can be configured to use Oracle Secure Enterprise Search (Oracle SES) as an external search engine for Content Server. For configuration information, see "Oracle Secure Enterprise Search".

Changed Features for 11g Release 1 (11.1.1)

11g Release 1 (11.1.1) includes the following changes:

- Directory Structure: The directory structure of an installed Oracle UCM instance has changed. Unlike in Release 10gR3, runtime files, configuration files, and files that must be shared between clustered Content Server instances, server configuration files, and file store may be in various locations. The following locations and terms are important to understanding an Oracle UCM 11g Release 1 (11.1.1) installation:

- IdcHomeDir: The variable used to refer to the directory in ECM_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 used to refer to the user-specified directory where an Oracle UCM server is deployed to run on an Oracle WebLogic Server application server. The DomainHome/ucm/short-product-id/bin directory contains the intradoc.cfg file and executables.

- short-product-id: The variable used to refer to the type of Oracle UCM server deployed on an Oracle WebLogic Server. Possible values include:

- cs (Content Server)

- ibr (Inbound Refinery)

- urm (Universal Records Management)

- IntradocDir: The variable used to refer to the root directory for configuration and data files specific to a Content Server instance deployed on an Oracle UCM domain on an Oracle WebLogic Server. This Idoc Script variable is configured for one type of Content Server instance: Content Server, or Inbound Refinery, or Universal Records Management. This directory can be located elsewhere, but the default location is DomainHome/ucm/short-product-id/.

- OracleTextSearch: The Oracle Text Search component has been incorporated into Content Server, so the OracleTextSearch engine is one of several search and indexing options. The OracleTextSearch interface has been integrated with the Repository Manager Indexer functions, so there is no separate Oracle Text Search page. See "OracleTextSearch".

1 Introduction to Oracle Content Server Administration

This guide assumes that Oracle Universal Content Management (UCM) and Oracle Content Server are already installed. For information on installing Oracle UCM and Oracle Content Server and setting initial post-installation configuration options, see Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite.

This chapter provides an introduction to Oracle UCM with Oracle Content Server and its administration tools. Subsequent chapters detail administration using Oracle WebLogic Server, additional configuration settings, context and administration procedures for security, components, search tools, content migration, and reference material.

The following topics are covered:

- "Understanding Oracle Universal Content Management and Oracle Content Server"

- "Administrative Accounts and Responsibilities"

- "Oracle Content Server Administration Tools"

- "Oracle Content Server Administration Utilities and Applets"

- "Launching Oracle Content Server Administration Applications"

1.1 Understanding Oracle Universal Content Management and Oracle Content Server

Oracle Universal Content Management and Oracle Content Server enable organizations to share, manage, and distribute business information using a Web site as a low-cost access point. Designed for the Web, this software is considered the unrivaled solution for medium to large companies for building secure business libraries with content check in, check out, revision control, and automated publishing in web-ready formats. Current information is available to authorized users anytime, anywhere. You can link virtually any type of file including letters, reports, engineering drawings, spreadsheets, manuals, sales literature, and more under one powerful system of knowledge distribution.

Oracle Content Server is designed for several types of users and administrators:

- Consumers: Users who just need to find, view, and print files. In a typical system, the majority of the users are consumers. These users do not need a user name and password to access the content server system unless security is placed on the files.

- Contributors: Users who need to create and revise files. To safeguard the integrity of the files, the contributors need a user name and password to check files in and out of the system.

- Administrators: Administrators who oversee an entire instance. Administrator responsibilities include setting up, maintaining, and managing Content Server users, content, and system configurations. Common tasks for an administrator include configuring the system to manage and index files, archiving and replicating information, working with content server security, adjusting system properties, reviewing log files, and so forth.

Users and administrators must be set up on Oracle WebLogic Server for authentication, and roles, groups and accounts can be assigned and modified in Content Server as needed.

1.2 Administrative Accounts and Responsibilities

A Content Server administrator must be assigned the 'sysmanager' role in Oracle WebLogic Server to have full administrative privileges for the Content Server and Admin Server. This administrator must set the user name and the password for the Content Server administrator. The administrator can define system roles, permissions, and accounts to be assigned to Content Server users with Oracle WebLogic Server. Content Server administrators are typically responsible for tasks including:

- Configuring Content Server system settings and processes

- Managing Content Server security configuration

- Creating and managing user roles, groups, and accounts

- Managing Content Server system and custom components

- Configuring Content Server search tools

- Managing Content Server system migration

- Monitoring and troubleshooting Content Server

Additional tasks including managing Content Server applications. For details, see Oracle Fusion Middleware Application Administration for Content Server.

1.3 Oracle Content Server Administration Tools

Oracle provides the following tools for managing Content Server:

- "Oracle Enterprise Manager Fusion Middleware Control Console"

- "Oracle WebLogic Server Administration Console"

- "Oracle WebLogic Scripting Tool"

- "Oracle Content Server Administration Utilities and Applets"

Administrators should use these tools, rather than edit configuration files, to perform administrative tasks unless a specific procedure requires you to edit a file. Editing a file may cause the settings to be inconsistent and generate problems.

1.3.1 Oracle Enterprise Manager Fusion Middleware Control Console

Oracle Enterprise Manager Fusion Middleware Control Console is a browser-based management application that is deployed when you install Oracle Universal Content Management with Oracle Content Server. From the Oracle Fusion Middleware Control Console you can monitor and administer a farm.

A farm is a collection of Oracle components managed by Fusion Middleware Control. A farm can contain a Managed Server domain and other Oracle Fusion Middleware system components that are installed, configured, and running on the domain. A Managed Server domain contains one or more Managed Servers running one or more applications, including Oracle WebLogic Server and Oracle Content Server.

Fusion Middleware Control organizes a wide variety of performance data and administrative functions into distinct, Web-based home pages. These home pages make it easy to locate the most important monitoring data and the most commonly used administrative functions for a component, all from your Web browser.

Fusion Middleware Control is the top-level management tool for Oracle Universal Content Management with Content Server, and it can be used to:

- Deploy, undeploy, and re-deploy Oracle Universal Content Management with Content Server

- Configure back-end services

- Configure security management

- Control process lifecycle

- Export and import data

- Access log files and manage log configuration

- Manage migrations

- Monitor performance

- Diagnose run-time problems

1.3.2 Oracle WebLogic Server Administration Console

The Oracle WebLogic Server Administration Console is a Web browser-based management application that you use to manage an Oracle WebLogic Server domain. The Administration Server hosts the Administration Console, which is a Web application accessible from any supported Web browser with network access to the Administration Server Managed Servers host applications.

Use the Administration Console to:

- Configure, start, and stop Oracle WebLogic Server instances

- Configure Oracle WebLogic Server clusters

- Configure Oracle WebLogic Server services, such as database connectivity (JDBC) and messaging (JMS)

- Configure security parameters, including creating and managing users, groups, and roles

- Configure and deploy your applications

- Monitor server and application performance

- View server and domain log files

- View application deployment descriptors

- Edit selected run-time application deployment descriptor elements

Note:
When configuring a production environment, the Administration Console's Change Center requires that before making configuration changes you lock configuration settings for a domain by clicking Lock & Edit.

For more information about the Oracle WebLogic Server Administration Console, see "Displaying the Oracle WebLogic Server Administration Console" in the Oracle Fusion Middleware Administrator's Guide.

1.3.3 Oracle WebLogic Scripting Tool

Oracle provides the Oracle WebLogic Scripting Tool (WLST) to manage Oracle Fusion Middleware components, such as Oracle Universal Content Management with Content Server, from the command line.

The WebLogic Scripting Tool is a complete, command-line scripting environment for managing Oracle WebLogic Server domains, based on the Java scripting interpreter, Jython. In addition to supporting standard Jython features such as local variables, conditional variables, and flow control statements, the WebLogic Scripting Tool provides a set of scripting functions (commands) that are specific to Oracle WebLogic Server. You can extend the WebLogic scripting language to suit your needs by following the Jython language syntax.

Oracle Universal Content Management with Oracle Content Server offers custom WebLogic Scripting Tool commands for managing Oracle Content Server application connections (to the repository, portlet producers, external applications, and other back-end services). All the WebLogic Scripting Tool commands specific to Oracle Universal Content Management with Oracle Content Server are described in the section on "Oracle UCM Content Server Custom WLST Commands" in the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

To run the Oracle WebLogic Scripting Tool from the command line

1. Navigate to the directory WL_ORACLE_HOME/common/bin, where WL_ORACLE_HOME is the directory where you have installed Oracle WebLogic Server.

2. From the command line, enter the command wlst.sh.
For example:

C:\WL_HOME\common\bin
wlst.sh

3. At the WLST command prompt, enter the following command to connect to the Oracle Universal Content Management Admin Server:

wls:\office>connect('user_name','password', 'host_name:port_number')

Use the Administration Server information for the variables in this command. For example:

connect('weblogic','weblogic', 'myhost.example.com:7001')

For help for this command, type help('connect') at the WLST command prompt. To list the available Oracle Universal Content Management commands, type: help('UCM')

Note:
If SSL is enabled, you must edit the wlst.sh file and append the following to JVM_ARGS:

-Dweblogic.security.SSL.ignoreHostnameVerification=tree
-Dweblogic.security.TrustKeyStore=DemoTrust

or set the environment variable:

setenv CONFIG_JVM_ARGS

-Dweblogic.security.SSL.ignoreHostnameVerification=tree
-Dweblogic.security.TrustKeyStore=DemoTrust

When connected to the managed servers where the Oracle UCM application is deployed, you can run any of the WLST commands for Oracle UCM. See "Oracle UCM Content Server Custom WLST Commands" in the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

1.4 Oracle Content Server Administration Utilities and Applets

Content Server provides specific administration utilities and applications for managing users, content, providers, archives, and so forth. This section includes the following topics:

- "Administration Interfaces"

- "Administration Tray"

- "Admin Applets Page"

See the browser considerations section in your installation and deployment guide for information about Java-browser plug-ins and applet display issues.

1.4.1 Administration Interfaces

The Oracle Universal Content Management system provides the following tools to configure and maintain Content Server system operation:

- Utilities

- Management Pages

- Applications

- Command Line

1.4.1.1 Utilities

The following tools can be started only as standalone applications from the computer where Content Server is installed:

- Batch Loader: Update or check in a large number of content items simultaneously.

- System Properties: Configure the system options and functionality of the content server.

- Content Analyzer: Confirm the integrity of the Content Server repository components, including the file system, database, and search index.

- ComponentWizard: Create and install custom components to modify Content Server behavior.

- ComponentTool: Install and enable or disable components using the command line.

1.4.1.2 Management Pages

The following pages can be accessed by using a Web browser and selecting the Administration link from the Content Server portal:

- Admin Server: Configure system-wide settings and view Content Server status.Each content server instance has its own Admin Server instance, which manages that content server on the Oracle WebLogic Server domain.

- Providers: Add providers, configure provider information, and test providers.

1.4.1.3 Applications

The following applications can be started as standalone applications from the Admin Applets Page on Content Server, as applets through a Web browser, or from the Apps menu in each of the tools. For information on running standalone applications see "Running Administration Applications in Standalone Mode". For details on the applications, see the Oracle Fusion Middleware Application Administrator's Guide for Content Server.

- User Admin: Manage the user base, set up security (by assigning roles and permissions to users), define aliases, and manage security groups.

- Workflow Admin: Set up workflows to route content to specific people for action.

- Repository Manager: Perform file diagnostics, file management functions, search data re-indexing, and subscription management functions.

- Configuration Manager: Manage content types, file formats, and custom metadata fields.

- Archiver: Export, import, transfer, and replicate content server files and information. For details, see the chapter on "Managing System Migration."

- Weblayout Editor: Build a Web site, work with reports, write queries.

1.4.1.4 Command Line

The IdcShell component enables administrators to run Idoc Script from a command line. It also includes some additional Idoc Script functions, listed in Table 1-1, and some dynamichtml definitions, listed in Table 1-2, which are useful for managing a content server or Inbound Refinery. The IdcShell component is installed (enabled) by default with Content Server.

Table 1-1 Command-Line IdocScript Functions

Function

Description

doService(serviceName)

Executes a serviceName in the current context.

formatBinder()

Formats a DataBinder for easy reading.

getWithTrace()

Traces the get() function and reports on the source of the data.

promptUser(text, flags)

Displays text on the console and reads a user response. If flags is NO_ECHO, then it does not echo input.

Table 1-2 Dynamichtml Definitions

Dynamichtml definition

Description

get_username

Prompts for a username on the console and assigns to userName.

get_password

Prompts for a password on the console and assigned to dPassword.

set_user_password

Sets a user's password.

create_user

Creates a new user, by default with Admin role.

1.4.2 Administration Tray

The Administration tray provide access to administration log files and administration pages for configuring and managing Content Server applications and tools. To access the Administration tray, log in as a Content Server administrator, then click Administration in the portal navigation bar. If you choose to use the Menu option for your portal, then click Administration to view the same options in a menu.

1.4.3 Admin Applets Page

The Admin Applets page provides access to administration applets and configuration tools. To access this page, log in as an administrator, click Administration in the portal navigation bar, then click Admin Applet.

Note:
You may experience problems if you start any Java applets (such as a Content Server administration applet or the multiple-file upload applet) from a browser that is using Sun's JDK 1.3/1.4 Java plug-in. These issues are related to authentication when launching an applet for the first time and applets closing when the parent window is changed.

1.5 Launching Oracle Content Server Administration Applications

You can launch Content Server administration applications using these methods:

- Running Administration Applications as Applets

- Running Administration Applications in Standalone Mode

1.5.1 Running Administration Applications as Applets

You can run several of the Content Server administration applications as applets from any Web browser with access to the content server. Applets are convenient for remote administration.

Note:
The Batch Loader, Component Wizard, System Properties, and Content Server Analyzer utilities cannot be run as applets; for security reasons, they must be run in standalone mode from the computer where the content server is deployed. See "Running Administration Applications in Standalone Mode" for details.
Some functions that are available in the standalone version of an application are not available from the applet version. See the documentation for each application for more information.

To run an administration application as a Java applet within a Java-enabled browser:

1. Open a browser window.

2. Log in to the content server as an administrator.

3. Click the Administration tray link in the portal navigation bar.

4. Click the Admin Applets link.

1.5.2 Running Administration Applications in Standalone Mode

You can run several Content Server administration Java applications in standalone mode from the computer where a content server is deployed. Some of the applications are the same as the applets accessed using a Web browser, such as Configuration Manager and Repository Manager. Some applications such as System Properties and Batch Loader can only run in standalone mode. The method required to start these programs differs slightly between Windows and UNIX installations.

Running the standalone version of an application offers greater security than browser applets, and enables you to send passwords without having them captured or copied from the Web or a network.

Important:
Before you can run Content Server administration applications in standalone mode, additional configuration is required to authenticate the applications on Oracle WebLogic Server and to have a JDBC connection to the system database and access to the WebLogic Server database connection. See "Configuring System Database Provider for Standalone Mode" and "Configuring External Database Provider for Standalone Mode".
If a standalone application is required to connect to an SSL-enabled database where digital certificates are used for authentication, then the database root CA certificate must be imported into the standard Java key store that the application uses to check trusted sources. For configuration details, see "Importing a Database Root CA Certificate into the Key Store for a Standalone Application" in Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite.

1.5.2.1 Configuring System Database Provider for Standalone Mode

Content Server administration applications that can only run as standalone applications require specific configuration to run in an Oracle WebLogic Server deployment for Content Server. The configuration changes for a standard (non-customized) Oracle WebLogic Server connection are necessary to have the applications authenticate Oracle WebLogic Server users and to set up a JDBC connection to the Oracle WebLogic Server system database.

To configure Oracle WebLogic Server system database connections:

1. Create a local (internal) content server user with Admin rights, using the User Admin applet in the browser interface.

2. Run ./SystemProperties.

3. Using VNC (or a similar tool such as putty or Xming), go to the domain/ucm/cs/bin directory. For example, /scratch/user/bea/user_projects/domains/domain/ucm/cs/bin

4. If you have already selected the Oracle thin client for JDBC connection on the Database tab, you can skip this step. Otherwise, on the Paths tab, in the Java Classpath field, enter a path to a JDBC driver for your system database. An Oracle driver is provided in the Enterprise Content Management install, for example:

/scratch/user/bea/ecm/ucm/idc/shared/classes/ojdbc5.jar

5. In the Database tab, enter all the necessary JDBC connection information for your system database (database type, database user name, database user password, and so on).

6. Click OK.
You should now be able to run a standalone application. For example, as the Administrator user you created on Content Server, run ./BatchLoader.

1.5.2.2 Configuring External Database Provider for Standalone Mode

You can create an external database provider in Content Server for standalone applications to connect directly to a database with JDBC without using the SystemDatabase Provider for the Oracle WebLogic Server data source. For standalone applications to use OracleTextSearch, you must configure the external database provider to include the JDBC connection information.

By default, the configuration of an incoming provider does not include values for JDBC Driver and JDBC Connection String. You must add these values, but be careful not to change the provider name because you cannot rename an existing provider. To change the name of a provider, you would need to delete it and then add it again.

For information about making changes to a provider, see "Editing Provider Information" in the chapter "Managing System Settings and Processes" in this guide.

1.5.2.3 Configuring JDBC Database Drivers for Standalone Mode

Oracle provides Fusion Middleware datadirect JDBC drivers for MS SQL Server and DB2 databases to support Content Server standalone applications. To configure Content Server so the standalone applications will work with the drivers:

1. Obtain the JDBC driver and fmwgenerictoken.jar from either the latest label in the DATADIRECT_MAIN_GENERIC series or from the Oracle UCM label.

2. Include the drivers in your class path by setting the following code, using your path to the driver jars:

JAVA_CLASSPATH_jdbcdrivers=path_to_driver_jars

3. Use the driver setting for the appropriate database. You must provide the server name, port number, and database name.
MS SQL Server:

JdbcDriver=com.oracle.fmwgen.jdbc.sqlserver.SQLServerDriver
JdbcConnectionString=jdbc:fmwgen:sqlserver://server1:port;DatabaseName=database

DB2:

JdbcDriver=com.oracle.fmwgen.jdbc.DB2.DB2DriverJdbcConnectionString=jdbc:fmwgen:db2://server1:port;DatabaseName=database

4. Restart the Content Server.

1.5.2.4 Running a Standalone Application on Windows Systems

Follow these steps to run a standalone Content Server administration application on a Windows operating system:

1. Select the application from the Windows Start menu:

- To run an administration application, from the Start menu select Programs, Content Server, Content Server-instance, Applications, and then the application.

- To run an administration utility, from the Start menu select Programs, Content Server, Content Server-instance, Utilities, then the utility.

For all applications except for Component Wizard and System Properties, a login screen is displayed. For Component Wizard and System Properties, the main screen of the application is displayed. It may take several seconds for the login screen or the application screen to appear, or the screen may be hidden by other windows.

2. Enter the administrator login name and password.

3. Click OK.
The main screen of the application is displayed.

1.5.2.5 Running a Standalone Application on UNIX Systems

Follow these steps to run a standalone Content Server administration application on a UNIX operating system:

1. Navigate to the DomainHome/ucm/cs/bin/ directory. Executable applications are listed.

2. Enter ./application_name, where application_name is the name of an executable file. If an application is not listed, it can be entered as a parameter to the IntradocApp application, as in this example:

%DomainHome%/bin/intradocApp workflow

3. Press Enter.
For all applications except for Component Wizard and SystemProperties, a login screen is displayed. For Component Wizard and SystemProperties, the main screen of the application is displayed.

4. Enter the administrator login name and password.

5. Click OK.
The main screen of the application is displayed.

2 Using Oracle Fusion Middleware Control to Manage Oracle UCM Content Server

This chapter describes how to use Oracle Enterprise Manager Fusion Middleware Control to access Oracle Universal Content Management (UCM) Content Server-related pages and perform Content Server configuration, monitoring, and management tasks.

This chapter includes the following sections:

- "Displaying the Fusion Middleware Control User Interface"

- "Navigating to the Home Page for Oracle UCM Content Server"

- "Starting Oracle UCM Content Server"

- "Shutting Down Oracle UCM Content Server"

- "Modifying Server Configuration Parameters for Oracle UCM Content Server"

- "Modifying Email Configuration Parameters for Oracle UCM Content Server"

- "Viewing Performance Information for Oracle UCM Content Server"

- "Viewing Log Information for Oracle UCM Content Server"

- "Viewing MBean Information for Oracle UCM Content Server"

Audience

The content of this chapter is intended for Fusion Middleware administrators (users granted the Admin role through the Oracle WebLogic Server Administration Console).

2.1 Displaying the Fusion Middleware Control User Interface

Fusion Middleware Control is a Web browser-based interface that you can use to monitor and administer a farm. A farm is a collection of components managed by Fusion Middleware Control. It can contain Oracle WebLogic Server domains, one Administration Server, one or more Managed Servers, clusters, and the Oracle Fusion Middleware components that are installed, configured, and running in the domain.

Fusion Middleware administrators can use Fusion Middleware Control to access and manage an Oracle Universal Content Management Content Server instance.

For more information, see "Getting Started Managing Oracle Fusion Middleware" in the Oracle Fusion Middleware Administrator's Guide.

To access Fusion Middleware Control:

Fusion Middleware Control is configured for a domain and it is automatically started when you start the Oracle WebLogic Server Administration Server.

1. Enter the Fusion Middleware Control URL in your Web browser. The URL must include the name of the host and the port number assigned during the installation. The following shows the format:
http://hostname.domain:port/em

For example: http://myhost.mycompany.com:7001/em

You can find the exact URL, including the administration port number, in the config.xml file:

- On Windows: DOMAIN_HOME\config\config.xml

- On UNIX: ORACLE_INSTANCE/config/config.xml

If the port number is not listed in the file, the default port number is 7001.

Figure 2-1 Oracle Fusion Middleware Control Login Page

2. Enter a valid Oracle Fusion Middleware administrator user name and password, and click Login.
A default user name for the administrator user is provided with the software. This is the account you can use to log in to Fusion Middleware Control for the first time. The password is the one supplied during the installation of Oracle Fusion Middleware.

The first page Fusion Middleware Control displays is the farm home page. You can also view this page at any time by selecting the name of the farm in the navigation pane.

Figure 2-2 Farm Home Page

From the navigation pane, you can expand the tree and select a target to view and manage components in your farm, including Universal Content Management and Oracle Content Server. For detailed instructions, see "Navigating to the Home Page for Oracle UCM Content Server".

2.2 Navigating to the Home Page for Oracle UCM Content Server

The Oracle Universal Content Manager (UCM) Content Server home page is your starting place for managing a content server instance.

From the home page you can:

- Check the general status of a content server

- View overall response time for services

- View resource information on concepts and tasks

Figure 2-3 Oracle Content Server Home Page

The Oracle Content Server home page displays the UCM menu.

From the UCM menu you can:

- Start and shut down a Content Server instance

- Configure Content Server instance parameters and email settings

- Monitor Content Server instance performance metrics

- Analyze diagnostic information and log files

- Modify attributes using the system MBean browser

- View general information about the Universal Content Management configuration

Figure 2-4 Oracle Content Server UCM Menu

To navigate to the Oracle Content Server home page:

1. Log in to Fusion Middleware Control. See "Displaying the Fusion Middleware Control User Interface".

2. In the navigation pane, expand the tree to select the appropriate target domain name (for example, UCM_ucm_domain).

3. Expand Content Management, then Universal Content Management, then Content Server.

4. Select Oracle Content Server (server_name) to navigate to the home page for your Oracle Content Server instance.

Figure 2-5 Navigation to the Oracle Content Server Page

2.3 Starting and Shutting Down Oracle UCM Content Server

This section covers the following topics:

- "Starting Oracle UCM Content Server"

- "Shutting Down Oracle UCM Content Server"

2.3.1 Starting Oracle UCM Content Server

1. In the navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

2. Expand Content Management, then Universal Content Management, then Content Server.

3. Select the Oracle Universal Content Management content server name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

4. From the UCM menu on the Oracle Content Server page, select Control, then Start. The Oracle Content Server is started.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

2.3.2 Shutting Down Oracle UCM Content Server

1. In the navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

2. Expand Content Management, then Universal Content Management, then Content Server.

3. Select the Content Server instance name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

4. From the UCM menu on the Oracle Content Server page, select Control, then Shut Down.... The Oracle Content Server is shut down.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

2.4 Modifying Configuration Parameters for Oracle UCM Content Server

This section covers the following topics:

- "Modifying Server Configuration Parameters for Oracle UCM Content Server"

- "Modifying Email Configuration Parameters for Oracle UCM Content Server"

2.4.1 Modifying Server Configuration Parameters for Oracle UCM Content Server

Server configuration contains information used to identify the Oracle Universal Content Management (UCM) Content Server deployment scenario.

From the Configuration page you can:

- Manage the HTTP address, which is the server address used to formulate full URLs in the Content Server user interface. This prevents users from being prompted to log in again because the domain name used to enter the server is not changed when links on pages are relative. Example setting: pc.idc.oracle.com.

- Manage the Intradoc server port, which is the port number listened to by the Content Server. This is a trusted connection where only the user ID is required to authenticate. Example setting: 4056.

- Manage the IP address filter, which is a list of IP addresses that are allowed to communicate to the Content Server through the Intradoc Server Port. The field accepts both IP and IPv6 addresses, with a pipe as the separator between addresses. This list must be well defined because it is a trusted connection. Example setting: 10.131.123.*.

- Choose whether or not to use Secure Sockets Layer (SSL), which is related to the HTTP server address and indicates that the full URL uses the secured HTTP nomenclature. For example, it generates an address with https://(HttpServerAddress)/... instead of http://(HttpServerAddress)/...

Figure 2-6 Oracle Content Server UCM Configuration Page

To modify the server configuration

1. In the navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

2. Expand Content Management, then Universal Content Management, then Content Server.

3. Select the Content Server instance name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

4. Use the UCM menu to select Configuration. The General Settings page displays.

5. In the Server Configuration section, in the HTTP Address field, enter an HTTP server address.

6. In the Server Configuration section, in the Intradoc Server Port field, enter a server port number.

7. In the Server Configuration section, in the IP Address Filter field, enter a list of IP addresses that can be used to access the server.

8. In the Server Configuration section, select the Use SSL check box to turn on SSL.

9. Click Apply.
The General Settings page updates with the configuration changes.

If you do not want to apply changes, click Revert to return to the previous configuration settings.

2.4.2 Modifying Email Configuration Parameters for Oracle UCM Content Server

Email configuration parameters contain information used to identify an Oracle Universal Content Management (UCM) Content Server deployment scenario.

From the Configuration page you can:

- Specify the mail server, which is the name of the mail server that the content server uses to send SMTP based e-mail. Example: mymailserver.company.com.

- Specify the SMTP port, which is the port number used to connect to the mail server. Example: 25.

- Specify the admin mail address, which is the administrator e-mail address that receives error messages. Such messages are generally logged, but this is an additional method of notification. Example: mymail@mail.com.

Figure 2-7 Oracle UCM Configuration Page

To modify the email configuration

1. In the navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

2. Expand Content Management, then Universal Content Management, then Content Server.

3. Select the Content Server instance name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

4. From the UCM menu on the Oracle Content Server page, select Configuration. The General Settings page displays.

5. In the Email Configuration section, in the Mail Server field, enter the name of a mail server.

6. In the Email Configuration section, in the SMTP Port field, enter a port number.

7. In the Email Configuration section, in the Admin Mail Address field, enter an e-mail address.

8. Click Apply.
The General Settings page updates with the configuration changes.

If you do not want to apply changes, click Revert to return to the previous configuration settings.

2.5 Viewing Performance Information for Oracle UCM Content Server

You can monitor performance information for Oracle Universal Content Management UCM) Content Server. Information includes a graphic of metrics for the content server, a summary of the most recent metric values, and a listing of recent service requests.

Figure 2-8 Oracle UCM Performance Summary Page

To view performance information for Oracle UCM Content Server

1. In the navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

2. Expand Content Management, then Universal Content Management, then Content Server.

3. Select the Content Server instance name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

4. From the UCM menu on the Oracle Content Server page, select Monitoring, then Performance Summary.
The Performance Summary page displays. It contains information in graphic format.

5. To select which metrics to display in performance graphs, click the Show Metric Palette button on the Performance Summary page. The Metric Palette lists available options for metrics to display in graphs on the Performance Summary page.
To view metrics in a table format, click Table View.

6. Check the box for each metric you want to display:

- Active Threads: The number of active threads.

- Active Database Connections: The number of active database connections made by the content server.

- Search Queries Cached: The number of search queries cached (rows).

- Hit to Miss Ratio: The hit to miss ratio for the number of search queries performed.

- Documents in GenWWW State: The number of documents waiting for Inbound Refinery in a GenWWW state.

- Documents Waiting to be Indexed in Done State: The number of documents waiting to be indexed in a Done state.

- Average Requests Per Sec: The average number of Services requested per second.

More details about performance information for Oracle Fusion Middleware are available from the Enterprise Manager Administration Console Online Help.

2.6 Viewing Log Information for Oracle UCM Content Server

You can view log messages and manage the log configuration for Oracle Universal Content Management (UCM) Content Server.

Figure 2-9 Oracle UCM Log Messages Page

To view log information

1. In the navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

2. Expand Content Management, then Universal Content Management, then Content Server.

3. Select the Content Server instance name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

4. From the UCM menu on the Oracle Content Server page, select Logs, then View Log Messages.
The Log Messages page displays. It contains information about the contents of all available log files. You can use this page to:

- Search for log messages logged during the past "n" hours.

- Search for log messages that were logged between two time intervals.

- Filter log messages based on message type.

To modify log configuration

1. In the navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

2. Expand Content Management, then Universal Content Management, then Content Server.

3. Select the Content Server instance name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

4. From the UCM menu on the Oracle Content Server page, select Logs, then Log Configuration.
The Log Configuration page displays. Use this page to configure basic and advanced log configuration settings for log levels and log files:

- Change log levels of persistent loggers (loggers defined in the logging configuration file).

- Change log levels of run-time loggers.

- Specify loggers that are currently neither persistent nor run time.

- Specify the log file configuration parameters such as the log file path and log rotation policies.

- Create a new log file configuration.

- Create a new log file configuration using an existing log file configuration.

- View the log file configuration parameters.

- Associate one or more loggers with a log file configuration.

More details about log information for Oracle Fusion Middleware is available from the Enterprise Manager Administration Console Online Help.

2.7 Viewing MBean Information for Oracle UCM Content Server

You can use the MBean browser to view MBean attribute information about Oracle Universal Content Management (UCM) Content Server.

Figure 2-10 Oracle UCM System MBean Browser Page

To view MBean information

1. In the navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

2. Expand Content Management, then Universal Content Management, then Content Server.

3. Select the Content Server instance name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

4. From the UCM menu on the Oracle Content Server page, select System MBean Browser.
The System MBean Browser page displays. This page shows the navigation pane with the UCM server name highlighted, and shows configuration MBean application deployment information for a UCM Content Server.

You can use the MBean browser to view or modify individual MBean attribute values, and to invoke MBean operations. Select the MBean and the attribute you want to view or modify. If you change an attribute value, click Apply.

For more information see "Understanding WebLogic Server MBeans" in Oracle Fusion Middleware Developing Custom Management Utilities With JMX for Oracle WebLogic Server.

3 Managing System Settings and Processes

This chapter describes concepts and tasks for managing Content Server system settings and processes on an ongoing basis. Tasks include managing system properties, multiple Content Servers, the search index, the Web filter, providers, and the content batchload process.

The following topics are covered:

- "Configuring System Properties"

- "Managing Content Server with the Admin Server"

- "Starting, Stopping, and Restarting Content Server"

- "Configuring the Search Index"

- "Configuring a File Store System"

- "Connecting to Outside Entities with Providers"

- "Managing Scheduled Jobs"

- "Batchloading Content"

- "Finding Error and Status Information"

3.1 Configuring System Properties

This section covers the following topics:

- "About System Properties"

- "Configuring General Options"

- "Configuring Content Security"

- "Configuring Internet Information"

- "Configuring the Database"

- "Configuring Content Server"

- "Configuring Locales"

- "Configuring Paths"

3.1.1 About System Properties

System properties are system-wide settings that enable you to tailor Content Server to your particular requirements. System properties are set during installation and are generally updated occasionally, or as needed, in contrast to other administration tools, which are used more regularly for maintenance of users and content.

Important:
Regardless of which method is used to modify system properties, you must restart Content Server for any configuration changes to take effect.

There are several ways to interact with system properties:

- TheAdmin Server enables you to configure a single content server instance . You also can enable and disable system components. The Admin Server can be accessed by using a Web browser and selecting the Administration link.

- TheSystem Properties utility enables you to configure a specific content server instance from the system on which the content server instance is deployed. For information on accessing the System Properties utility, see "Running Administration Applications in Standalone Mode".

- Most system properties settings correspond to a configuration variable in one of the following configuration files:

- IntradocDir/config/config.cfg

- DomainHome/ucm/short-product-id/bin/intradoc.cfg

- IntradocDir/search/search.cfg

It is recommended that you make changes to these files through the Admin Server or System Properties tool to ensure that the settings are entered correctly. While it is possible to edit these files directly using a text editor, it may allow errors to be introduced. See the Oracle Fusion Middleware Idoc Script Reference Guide for more information on configuration variables.

Note:
For the System Properties utility to run as a standalone application for a content server instance on Oracle WebLogic Server, additional configuration may be required. See "Configuring System Database Provider for Standalone Mode".

There are many techniques for optimizing the performance of Content Server. One of the types of tuning involves changing default parameters and software settings that affect the core Content Server performance. System optimization and performance tuning is often accomplished by adjusting system settings and configuration variables or tuning resources such as databases and indexes.

For example, as the content in your content server instance increases, you may experience a shortage of available space. In this case, moving the vault, weblayout, and search index directories to another drive with more space can help alleviate storage problems. Moving these directories requires adding entries into the DomainHome/ucm/cs/bin/intradoc.cfg file.

You do not have to log in as the system administrator to access the System Properties application. You only need access to the local computer where the content server is installed.

3.1.2 Configuring General Options

You can set general options on the System Properties: Options Tab or on the Admin Server: General Configuration Page. You must restart the content server for any configuration changes to take effect.

If you plan to use the Batch Loader utility to update and insert a large number of files on your Content Server system simultaneously, you must create a batch load file. Two of the optional parameters that you can include in your batch load file are primaryOverrideFormat and alternateOverrideFormat. However, these options only work as parameters in the batch load file if you enable the IsOverrideFormat configuration variable. You can set this variable using the System Properties application.

3.1.2.1 Revision Label Sequence

The metadata field named Revision has a default revision number sequence of 1, 2, 3, 4, 5, and so forth. This number increments automatically for each revision of a document.

You can override the Revision default by changing the definition of the revision label. The revision label consists of two parts: a major and minor revision sequence. The Major Revision Label Sequence is the first number or letter and the Minor Revision Label Sequence follows. For example, in the revision sequence 1a, 1b, 1c, 2a, 2b, 2c, 3a, 3b, 3c, and so forth, the numbers 1, 2, 3 are the major revision sequence and a, b, c are the minor revision sequence.

3.1.2.2 Revision Label Ranges

Both the major and minor revision sequences are defined as a range of numbers or letters. The major sequence can have multiple ranges, while the minor sequence can only have one range.

The following are the restrictions on defining the range:

- Numbers or letters can be used, but not both. For example, 1-10 is a valid range but A-10 is not a valid range.

- Letter ranges can have only one letter. For example, A-Z is a valid range but AA-ZZ is not a valid range.

3.1.2.3 Revision Examples

The following are examples of different revision sequences and how you would define the major and minor revision entries in the config.cfg file.

Example 1

MajorRevSeq=A-D,1-99

The revision sequence is A, B, C, D, 1, 2, 3, 4, and so forth.

Example 2

MajorRevSeq=1-99

MinorRevSeq=a-c

The revision sequence is 1a, 1b, 1c, 2a, 2b, 2c, 3a, 3b, 3c, and so forth.

3.1.2.4 Revision Configuration Settings

To change the default revision sequence manually in the IntradocDir/config/config.cfg file, enter the following name/value pairs:

- MajorRevSeq=range1,range2,range3...

- MinorRevSeq=range

where range1,range2,range3... and range are the defined range sequence.

3.1.2.5 Chunking Function

The Content Server Chunking function protects large data transfers from transfer failures by dividing data into chunks and transferring one chunk at a time. If a transfer fails, all chunks transferred to the content server before failure are saved, and the transfer can be resumed from the point of failure.

Note:
If the client session using the Chunking function is killed, either by timeout or by closing the client browser, the transfer will fail.

You can use the Chunking function with the upload applet.

3.1.2.6 Configuring the Chunking Function

To enable and configure the Chunking function:

1. Enable the upload applet or the HTTP provider. See "Configuring General Options".

- To enable the upload applet, see "Configuring General Options".

- To create an HTTP provider, see "Additional Content Server Security Connections".

2. Set the following configuration settings in the Additional Configuration Variables box on the Admin Server: General Configuration Page:

DisableHttpUploadChunking=false
AppletChunkThreshold=size in bytes
AppletChunkSize=size in bytes

The AppletChunkSize setting sets the size of the individual chunks. The AppletChunkThreshold setting sets the minimum file size that will use the Chunking function. Both of these values default to 1M.

3. To debug the Chunking function, set ChunkedRequestTrace=true.
This setting enables you to view the chunked requests on Admin Server Output Page.

4. Save the changes.

5. Restart the content server.

3.1.3 Configuring Content Security

You can set Content Server content security options on the System Properties: Content Security Tab or on the Admin Server: Content Security Page.

You must restart the content server for any configuration changes to take effect.

3.1.4 Configuring Internet Information

You can set Content Server Internet options on the System Properties: Internet Tab or on the Admin Server: Internet Configuration Page.

You must restart the content server for any configuration changes to take effect.

3.1.5 Configuring the Database

Content Server uses an Oracle WebLogic Server data source to communicate with the system relational database where metadata and other information is stored. The Oracle WebLogic Server Administration Console must be used to manage the database connection information, therefore JDBC username and password information is not stored in the IntradocDir/config/config.cfg file, and it is not managed through the System Properties utility.

Note:
If you set database connection information for Oracle WebLogic Server using the Content Server System Properties utility, the JDBC username and password are encrypted and stored in an unspecified location.

For more information on configuring databases with Content Server, see the Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite.

3.1.5.1 Configuring Database Driver Settings for Standalone Applications

If you want to use Content Server standalone applications such as System Properties or Batch Loader with a database other than Oracle Database, Oracle provides Fusion Middleware datadirect JDBC drivers for DB2, and MS SQL Server databases. For details, see "Configuring JDBC Database Drivers for Standalone Mode".

3.1.5.2 Configuring IBM DB2 Database Searches in Content Server

An IBM DB2 database does not support the keyword CONTAINS in search queries. The correct configuration of a Content Server instance for IBM DB2 searches requires the addition of the flag SSUseContains=false on the General Configuration page and a restart of Content Server. To configure IBM DB2 database searches in Content Server:

1. Open a new browser window, and log in to Content Server as a system administrator (with the sysmanager role).

2. Under Administration, click Admin Server.

3. In the option list for the Content Server instance, click General Configuration.
The General Configuration page is displayed.

4. Add the following line to the Additional Configuration Variables box:

SSUseContains=false

5. Click Save.

6. Restart Content Server.

3.1.6 Configuring Content Server

You can set Content Server options on the System Properties: Server Tab. For security reasons, the Admin Server cannot be used to configure these options. You must use the standalone application to configure options. For details about using standalone applications, see "Running Administration Applications in Standalone Mode".

Certain Content Server configuration options are set using Oracle Enterprise Manager Fusion Middleware Control. For details, see Chapter 2, "Using Oracle Fusion Middleware Control to Manage Oracle UCM Content Server".

You must restart the content server for any configuration changes to take effect.

Caution:
If you do not use a Hostname filter, IP Address filter, or some other network-based security, you will have a security hole in your content server instance. For example, with no login, any user with in-depth knowledge of the system could create or modify any other user to have sysadmin access.

Hostname filter or IP Address filter values must be set to allow communication with the content server in the following situations:

- Running Inbound Refinery and PDF Converter (even on the same physical computer as the content server).

- Transferring content server archives between computers.

- Configurations where the Web server and the content server are on different systems.

- EJB-enhanced operations.

- Using the IdcCommand or IdcCommandX utilities on a system separate from the content server. (You will need to change the default value and specify the IP address of the Web server.)

3.1.7 Configuring Locales

You can use the System Properties Localization tab to change language-specific issues such as date/time format, default time zone, sort order, and default interface language.

3.1.7.1 Date Format

The default English-US locale uses two digits to represent the year (yy), where the year is interpreted to be between 1969 and 2068. In other words, 65 is considered to be 2065, not 1965. If you want years before 1969 to be interpreted correctly in the English-US locale, you must change the default date format for that locale to use four digits to represent years (yyyy).

This issue does not apply to the English-UK locale, which already uses four digits for the year.

To modify the default English-US data format:

1. Start the System Properties applet:
Windows:

Select Start, then All Programs, then Content Server, then [Instance Name], then Utilities, then System Properties.

UNIX:

The System Properties utility is located in the /bin subdirectory of the Content Server installation directory.

2. Open the Localization tab.

3. Select the English-US entry in the list of locales, and click Edit.
The Configure Locale dialog is displayed.

4. Modify the date format to use four digits for the year (yyyy) rather than two (yy).

5. After you are done editing, click OK to close the Configure Locale dialog.

6. Click OK to apply the change and exit System Properties.

7. Stop and restart the Content Server (otherwise the change will not take effect).

3.1.7.2 Interface Language

The default interface language for Content Server can be specified in several ways:

- Select a default language in the Localization tab of the System Properties utility, using the same basic procedure described in "Date Format".

- Use the Content Server navigation portal to selection Administration, then Localization. Select a check box for a default language from the list of Enabled Locales on the Localization Administration page.

3.1.8 Configuring Paths

You can use the System Properties: Paths Tab to change the location of the help browser, Java classpath, and the shared directory path. For security reasons, the Admin Server cannot be used to configure the path options. You must use the standalone application for this configuration.

You must restart the content server for any configuration changes to take effect.

3.2 Managing Content Server with the Admin Server

This section includes the following topics:

- "About the Admin Server"

- "Viewing Server Output"

3.2.1 About the Admin Server

The Admin Server is a collection of Web pages that enable you to configure system-wide settings for a content server instance. If you use the Admin Server, keep the following restrictions in mind:

- You must be logged in as the system administrator or a user with the sysmanager role to access the Admin Server.

- To administer a Content Server instance with the Admin Server, the instance must be accessible on the local file system. The drive on which any remote instance is installed must be mapped or mounted to the local drive.

- The Admin Server must run on the same file system as the content server that it administrates.

- Previous to 11g Release 1 (11.1.1), the Admin Server could be used to start, stop, and restart Content Server. By default those functions are now managed through Oracle WebLogic Server or Fusion Middleware Control. See "Starting, Stopping, and Restarting Content Server".

3.2.2 Viewing Server Output

To view the Java output of the Admin Server and Content Server:

1. Display the Admin Server Page.

2. Click the View Server Output link.
The Admin Server Output Page is displayed.

3. To refresh the output messages, click Refresh. To clear the output messages, click Clear.

3.3 Starting, Stopping, and Restarting Content Server

There are several methods for starting, stopping, and restarting Oracle Content Server. Which method you choose depends on your requirements, your authorization, and the task you want to complete. For example, when certain configuration changes are made to Content Server, such as when components are enabled or disabled, Content Server must be restarted. Available methods include:

- Oracle WebLogic Server Administration Console

- Oracle WebLogic Scripting Tool (WLST) commands

- Oracle Enterprise Manager Fusion Middleware Control

Note:
In earlier releases, the Admin Server could be directly used to start, stop, and restart Content Server. This functionality has been replaced in 11g Release 1 (11.1.1), although other functions are still managed with the Admin Server.

Procedures are described in these topics:

- "Starting Content Server"

- "Stopping Content Server"

- "Restarting Content Server"

3.3.1 Starting Content Server

Content Server is initially started during the process of installing and deploying the instance. At other times you may want to start a Content Server instance. For example, you would start an instance after it has been stopped when changing a Content Server configuration setting.

- Starting Content Server with Oracle WebLogic Server

- Starting Content Server with Oracle WebLogic Scripting Tool Commands

- Starting Content Server with Fusion MIddleware Control

3.3.1.1 Starting Content Server with Oracle WebLogic Server

The Oracle WebLogic Server Administration Console is available to Content Server administrators because these users must have administrative privileges to manage Content Server. The Node Manager must be configured and running in order to start Content Server.

To start Content Server with the Oracle WebLogic Server Administration Console:

1. On the Administration Console Domain Structure navigation bar, select Environment, then Servers.

2. On the Conversion tab for the Summary of Servers section, click the name of the Oracle UCM server for Oracle Content Server.

3. In the Settings for server_name section, click the Control tab.

4. In the Server Status area, click Start.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.3.1.2 Starting Content Server with Oracle WebLogic Scripting Tool Commands

The Oracle WebLogic Scripting Tool (WLST) provides a quick method for using command lines to execute actions.

To start Content Server with Oracle WLST commands:

Run the command to start the Oracle WebLogic Server Administration Console, then the command to start Oracle UCM (in this example, named UCM_server1):

MW_HOME../domain_name/bin/startWeblogic.sh
MW_HOME../domain_name/bin/startManagedWeblogic.sh UCM_server1

For more information, see Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

3.3.1.3 Starting Content Server with Fusion MIddleware Control

Oracle Enterprise Manager Fusion Middleware Control can be used by administrators to manage multiple domains, including Oracle WebLogic Server running Content Server. This method of starting a Content Server also provides access to information about the Oracle UCM domain in which Content Server is deployed.

To start Content Server with Fusion Middleware Control:

1. In the Fusion Middleware Control interface navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

2. Expand Content Management, then Universal Content Management, then Content Server.

3. Select the Oracle UCM Content Server name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

4. From the UCM menu on the Oracle Content Server page, select Control, then Start. The Content Server is started.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.3.2 Stopping Content Server

Content Server may be stopped for several reasons, including changing the configuration, such as enabling or disabling a server component.

- Stopping Content Server with Oracle WebLogic Server

- Stopping Content Server with Oracle WebLogic Scripting Tool Commands

- Stopping Content Server with Fusion MIddleware Control

3.3.2.1 Stopping Content Server with Oracle WebLogic Server

The Oracle WebLogic Server Administration Console is available to Content Server administrators because the users must have administrative privileges to manage Content Server. The Node Manager must be configured and running in order to stop Content Server.

To stop Content Server with the Oracle WebLogic Server Administration Console:

1. On the Administration Console Domain Structure navigation bar, select Environment, then Servers.

2. On the Conversion tab for the Summary of Servers section, click the name of the Oracle UCM server for Oracle Content Server.

3. In the Settings for server_name section, click the Control tab.

4. In the Server Status area, click Shutdown.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.3.2.2 Stopping Content Server with Oracle WebLogic Scripting Tool Commands

The Oracle WebLogic Scripting Tool (WLST) provides a quick method for using command lines to execute actions.

To Stop Content Server with Oracle WLST commands:

Run the command to stop Oracle UCM (in this example, named UCM_server1), then, if necessary, run the command to stop the Oracle WebLogic Server Administration Console:

MW_HOME../domain_name/bin/stopManagedWeblogic.sh UCM_server1
MW_HOME../domain_name/bin/stopWeblogic.sh

For more information, see Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

3.3.2.3 Stopping Content Server with Fusion MIddleware Control

Oracle Enterprise Manager Fusion Middleware Control can be used by administrators to manage multiple domains, including Oracle WebLogic Server running Content Server. This method of stopping a Content Server also provides access to information about the Oracle UCM domain in which Content Server is deployed.

To stop Content Server with Fusion Middleware Control:

1. In the navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

2. Expand Content Management, then Universal Content Management, then Content Server.

3. Select the Content Server instance name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

4. From the UCM menu on the Oracle Content Server page, select Control, then Shut Down.... The Oracle Content Server is shut down.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.3.3 Restarting Content Server

Content Server may be restarted for several reasons, including changing the configuration, such as enabling or disabling a server component.

- Restarting Content Server with Oracle WebLogic Server

- Restarting Content Server with Oracle WebLogic Scripting Tool Commands

- Restarting Content Server with Fusion MIddleware Control

3.3.3.1 Restarting Content Server with Oracle WebLogic Server

The Oracle WebLogic Server Administration Console is available to Content Server administrators because the users must have administrative privileges to manage Content Server. The Node Manager must be configured and running in order to stop and start Content Server.

To restart Content Server with the Oracle WebLogic Server Administration Console:

1. On the Administration Console Domain Structure navigation bar, select Environment, then Servers.

2. On the Conversion tab for the Summary of Servers section, click the name of the Oracle UCM server for Oracle Content Server.

3. In the Settings for server_name section, click the Control tab.

4. In the Server Status area, click Shutdown.

5. Confirm that Oracle Content Server has stopped, and then click Start.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.3.3.2 Restarting Content Server with Oracle WebLogic Scripting Tool Commands

The Oracle WebLogic Scripting Tool (WLST) provides a quick method for using command lines to execute actions.

To Restart Content Server with Oracle WLST commands:

Run the command to stop Oracle UCM (in this example, named UCM_server1), the command to stop the Oracle WebLogic Server Administration Console, then the command to start the Oracle WebLogic Server Administration Console, then the command to start Oracle UCM:

MW_HOME../domain_name/bin/stopManagedWeblogic.sh UCM_server1
MW_HOME../domain_name/bin/stopWeblogic.sh
MW_HOME../domain_name/bin/startWeblogic.sh
MW_HOME../domain_name/bin/startManagedWeblogic.sh UCM_server1

For more information, see Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

3.3.3.3 Restarting Content Server with Fusion MIddleware Control

Oracle Enterprise Manager Fusion Middleware Control can be used by administrators to manage multiple domains, including Oracle WebLogic Server running Content Server. This method of stopping and starting a Content Server also provides access to information about the Oracle UCM domain in which Content Server is deployed.

To restart Content Server with Fusion Middleware Control:

1. In the navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

2. Expand Content Management, then Universal Content Management, then Content Server.

3. Select the Content Server instance name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

4. From the UCM menu on the Oracle Content Server page, select Control, then Shut Down....

5. Confirm that the Oracle Content Server instance is shut down.

6. From the UCM menu on the Oracle Content Server page, select Control, then Start. The Oracle Content Server is started.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.4 Configuring the Search Index

This section covers the following topics:

- "Variances in Indexing Tools and Methods"

- "Working with the Search Index"

- "Text File Full-Text Indexing"

- "Managing Zone Text Fields"

- "Indexing with Databases"

- "Searching Content Using the Oracle Query Optimizer Component"

3.4.1 Variances in Indexing Tools and Methods

Content Server interfaces with a variety of indexing tools such as commercial search engines and databases. The indexing tool to use is chosen before installation based on the purpose and environment in which the content server performs.

Each indexing tool provides full-text indexing and metadata-only indexing. Full-text indexing means that every word in a file is indexed, not only its metadata. Full-text indexing takes longer than metadata indexing; however, it can return a more comprehensive result set. Metadata-only indexing means that every word in the stored content information is indexed. Metadata-only indexing is faster than full-text indexing. By default Content Server is configured to use metadata-only indexing.

3.4.2 Working with the Search Index

This section covers these topics:

- "About the Search Index"

- "Updating the Search Index"

- "Rebuilding the Collection"

- "Configuring the Update or Rebuild"

- "Disabling Full-Text Indexing"

3.4.2.1 About the Search Index

The Repository Manager utility provides an Indexer tab which administrators can use to perform actions on the search index.

To access the Repository Manager, in the Administration tray click Admin Applets, then click Repository Manager. You can also access the Repository Manager as a standalone application. See "Running Administration Applications in Standalone Mode" for details.

The Indexer tab on the Repository Manager screen enables administrators (not subadministrators) to perform these actions:

- Update the Search Index: Incrementally updates the index database. This is usually not necessary because the index is automatically updated approximately every five minutes by the server.

- Rebuild the Collection: The search index is entirely rebuilt, and the old index collection is replaced with a new index collection.

- Suspend an Update or a Rebuild: Stops the update or rebuild temporarily. You can restart the process by clicking the appropriate Start button.

- Cancel Update Search: Index update process terminates, and only files processed to that point are accessible to the search engine.

- Cancel Rebuild Collection: Index rebuild process terminates, and the previous index database continues to be used by the search engine.

For more information about managing the repository, see Oracle Fusion Middleware Application Administrator's Guide for Content Server.

3.4.2.2 Updating the Search Index

1. On the Repository Manager screen, click the Indexer tab.

2. Click Start in the Automatic Update Cycle area.

3.4.2.3 Rebuilding the Collection

1. On the Repository Manager screen, click the Indexer tab.

2. Click Start in the Collection Rebuild Cycle area.

Note:
OracleTextSearch provides a Fast Rebuild function, which you can use through the Repository Manager Indexer function if your site uses the OracleTextSearch feature. For details, see "Fast Rebuild".

3.4.2.4 Configuring the Update or Rebuild

To set the parameters for a search index update or collection rebuild:

1. On the Repository Manager screen, click the Indexer tab.

2. Click Configure in either the Automatic Update Cycle portion of the screen or the Collection Rebuild Cycle portion.
Either the Automatic Update Cycle Screen or the Collection Rebuild Cycle Screen is displayed.

3. Specify the number of content items (files) per indexer batch. This is the maximum number of files that the search index will process simultaneously.

4. Specify the content items (files) per checkpoint. This is the number of files that will go through all relevant indexing states at a time. You can have multiple batches of files indexed per checkpoint.

5. Specify the indexer debug level. This is the amount of information pertaining to each file to display in the server window.

6. Click OK.

3.4.2.5 Disabling Full-Text Indexing

You might want to disable full-text indexing if, for example, you want to conserve file space or if you do not require full-text searching for specific content types. Even if you disable full-text indexing, metadata is still indexed.

To disable full-text indexing on specific files:

1. Define a format in the Configuration Manager screen named application/noindex.

2. Enable the Allow Override Format on Check In setting. See "Configuring General Options".

3. When a user checks in a file that they do not want to be indexed, they should select the application/noindex format. This applies to standard files, batch loads, and archived revisions.

3.4.3 Text File Full-Text Indexing

If you have configured the content server to use DATABASE.FULLTEXT or OracleTextSearch as your indexing engine, Content Server uses the Outside In Content Access module to export content to a text file upon check-in. The text file is then passed to the full-text indexer for full-text indexing.

Note:
When the Outside In Content Access module converts a PostScript file, the conversion process produces text that contains extra characters. Unfortunately, this creates a file that is full-text indexed but cannot be full-text searched.

If you use DATABASE.FULLTEXT, a full-text search can be problematic on large documents. By default, the maximum document size that is indexed is 10MB. This can be changed by setting the MaxIndexableFileSize configuration variable in the Content Server repository. The default is MaxIndexableFileSize=10485760. If larger documents require full-text indexing, the value of MaxIndexableFileSize should be increased.

3.4.4 Managing Zone Text Fields

The functionality described in this section is only available if you have installed and enabled the Database Search Contains Operator feature.

Note:
This feature is not required in OracleTextSearch.

This section covers these topics:

- "About Zone Text Fields"

- "Enabling and Disabling Zone Text Fields"

- "Changing the MinTextFullFieldLength Variable"

- "Disabling Database Search Contains Operator"

3.4.4.1 About Zone Text Fields

The Database Search Contains Operator feature enables you to use the Contains search operator to search text fields when performing Database and Database Full Text searches on SQL Server and Oracle. You must first enable the text fields that can be queried using the Contains search operator. These text fields are called zone text fields.

When a text field is added as a zone text field, the text within the field is parsed and a full-text index for the field is created in the database. The database performs all the work of creating the index, and the index is dropped from the database if the text field is disabled as a zone text field. Therefore, there is no need to rebuild the collection after enabling or disabling text fields as a zone text fields.

Important:
Changing a text field to a zone text field can be a very time-consuming operation. The amount of time it takes to parse the text and create the full-text index depends on the number of content items in the content server and the amount of text stored in the text field. However, after the text field has been indexed, you should not experience significant performance issues when updating and adding content items.

When a text field has been enabled as a zone text field, the Contains search operator is available for the text field on the Advanced Search page. It is represented as the Has Word option in the list next to the text field.

Figure 3-1 Has Word option

3.4.4.2 Enabling and Disabling Zone Text Fields

To enable or disable zone text fields, complete the following steps:

1. Log in to Content Server as an administrator.

2. Select Zone Fields Configuration from the Administration menu or the Admin Applets page. The Zone Fields Configuration Page is displayed.

3. Select the search engine from the list.

4. To enable text fields as zone text fields, complete the following steps:

1. Select the text fields in the Text Fields list. You can use the [Ctrl] and [Shift] keys on your keyboard to select multiple fields.

By default, text fields with a field length of 20 characters or less are not included in the Text Fields list. You can change this setting by modifying the MinFullTextFieldLength configuration variable. For details, see "Changing the MinTextFullFieldLength Variable".

1. Click the left arrow button to move the text fields to the Zone Text Fields list.

2. Click Update.

Important:
Changing a text field to a zone text field can be a very time-consuming operation. The amount of time it takes to parse the text and create the full-text index depends on the number of content items in the content server and the amount of text stored in the text field. However, when the text field has been indexed, you should not experience significant performance issues when updating and adding content items.

1. To disable zone text fields, complete the following steps:

1. Select the zone text fields in the Zone Text Fields list. You can use the [Ctrl] and [Shift] keys on your keyboard to select multiple fields.

2. Click the right arrow button to move the text fields to the Text Fields list.

3. Click Update.

2. When enabling and disabling zone text fields, consider the following:

- If you start making changes to the lists and you then want to revert to the last saved lists, click Reset.

- Custom text fields (the Comments field and any customer created text fields) are shared between the Database and Database search engines, and therefore changing the status of these text fields for one search engine also applies the changes to the other search engine.

- Standard text fields (Author, Content ID, Content Type, Title, and so on) can be enabled or disabled independently for each search engine.

- The database performs all the work of creating the indexes, and the index are dropped from the database if the text fields are disabled as zone text fields. Therefore, there is no need to rebuild the collection after enabling or disabling text fields as a zone text fields.

- You must disable a zone text field before the field can be deleted from the content server using Configuration Manager. If you delete an enabled zone text field using Configuration Manager and then click Update Database Design, you will receive an error.
Disabling the zone text field drops the index for the field from the database, allowing the field to be deleted from the database. As an alternative to disabling the zone text field, you could log in to the database and issue a command to drop the index for the field, and then delete the field.

- You might want to disable all zone text fields before uninstalling the feature. Otherwise, you will not be able to delete the zone text fields from the content server unless you reinstall the feature to disable the zone text fields or drop the indexes for the zone text fields from the database manually.

3.4.4.3 Changing the MinTextFullFieldLength Variable

By default, text fields with a field length of 20 characters or less are not included in the Text Fields list. You can change this setting by modifying the MinFullTextFieldLength configuration variable. To change this variable, complete the following steps:

1. Using a text editor, open the config.cfg file located in the IntradocDir/config/ directory.

2. Add the MinFullTextFieldLength configuration variable, and set its value (the default value is 21). For example:

MinFullTextFieldLength=16

3. Save your changes to the config.cfg file.

4. Restart the content server.

3.4.4.4 Disabling Database Search Contains Operator

Before disabling the feature, you might want to disable all zone text fields. The database contains an index for each enabled zone text field (the indexes are dropped when the zone text fields are disabled). If the database contains an index for a field, it will not let you delete the field from your content server using Configuration Manager. For more information, see "Enabling and Disabling Zone Text Fields".

If you disable the feature and later want to delete a field that is enabled as a zone text field, you can use one of the following options:

- Reinstall the feature, disable the zone text field, use Configuration Manager to delete the field, and uninstall the feature.

- Log in to the database and issue a command to drop the index for the field, and then use Configuration Manager to delete the field.

3.4.5 Indexing with Databases

If your system is set up to provide indexing and searching capabilities with databases, your system integrator would have added one of the following lines in IntradocDir/config/config.cfg:

- Metadata Searching Only:

SearchIndexerEngineName=DATABASE.METADATA

DATABASE.METADATA is supported in all databases supported by Oracle Fusion Middleware 11g Release 1 (11.1.1).

- Full-text Searching:

SearchIndexerEngineName=ORACLETEXTSEARCH

ORACLETEXTSEARCH is supported in Oracle Database version 11.1.0.7 and above.

- Full-text Searching:

SearchIndexerEngineName=DATABASE.FULLTEXT

DATABASE.FULLTEXT is supported in SQL Server, and in Oracle Database (all supported versions).

The dbfulltextsearch script appropriate for the supported database would then be run.

- By default, full-text indexing is applied to all converted files.

- By default, the content server full-text indexes files that are passed through or converted to any of the following formats:
Oracle Supported Formats

- pdf

- html

- htm

- xls

- hcsp

- text

- txt

- doc

- rtf

- ppt

MS SQL Supported Formats

- text

- txt

- htm

- html

- doc

- msword

- ms-word

- ms-powerpoint

- ppt

- ms-excel

- xls

For example, if you want to convert your Microsoft Word (.doc) files to text files instead of PDF, you can specify this in the Configuration Manager. That is, when you use the File Formats option to map the .doc file extension to a text format, then this defines how the file is converted to a Web viewable format. In this case, the text file is fully indexed before it is passed to the Web site.

For more information about the Configuration Manager's File Formats option, see the Oracle Fusion Middleware Application Administrator's Guide for Content Server.

- You can enable contributors to specify whether to full-text index a file by enabling the format override feature in System Properties. (See "Configuring General Options".)
For example, if you have used the Configuration Manager's File Formats option to map Corel WordPerfect (.wpd) files to use a text format and a contributor selects the use default option in the Format field on the checkin page, the file will be converted to text and full-text indexed. If the contributor selects Corel WordPerfect Document, the file will be passed through in its native format and will not be full-text indexed.

For more information about the Configuration Manager's File Formats option, see the Oracle Content Server Application Administrator's Guide for Content Server.

- When you use full-text searching, a search is case sensitive for metadata, and case insensitive for full text. For Content ID, however, lower case letters are converted to upper case, so Content ID can not be searched with lower case letters.

3.4.5.1 Database-Supported File Formats

If you define a file format to PASSTHRU in the native format, and the format name contains one of the types listed above (such as application/ms-excel.native), the passed through native file will be full-text indexed by default.

Alternatively, you can use configuration variables to control whether a document is full-text indexed. To manage the full-text indexing and search of specific document format types, add applicable entries to IntradocDir/config/config.cfg, and save the file. Full-text indexing configuration variables include:

- FormatMap

- ExceptionFormatMap

3.4.5.1.1 FormatMap

The FormatMap configuration variable controls whether files of a specific format should be included in the full-text search index. It is a comma-delimited list of all the formats that will be full-text indexed. The decision is made by taking the MIME type assigned to a file, splitting the MIME type apart at any slash (/) or period (.), and then checking if that value is in the FormatMap list.

For example, application/vnd.msword will turn into a list of three items:

- application

- vnd

- msword

If FormatMap has msword in its list, then the indexer engine will attempt to full-text index the file. the comparison test is not case sensitive.

3.4.5.1.2 ExceptionFormatMap

The ExceptionFormatMap configuration variable is used to exclude document formats from the FormatMap test. Any format that satisfies the ExceptionFormatMap test will not be full-text indexed. This test is done after splitting the MIME format at slashes (/), but not periods(.). For example, if msword is included in the exceptions list, then the MIME format application/msword is excluded but not application/vnd.mssword.

3.4.6 Searching Content Using the Oracle Query Optimizer Component

The Oracle Query Optimizer component is installed (enabled) by default with Content Server. The functionality only works with the Oracle database.

This section covers these topics:

- "About The Oracle Query Optimizer Component"

- "Query Optimization Process"

- "How Reformatted Queries Optimize Searches"

- "Types of Recognized Hints"

- "Query Hints Syntax"

- "Additional Supported Sort Constructs"

- "The Hint Rules Table"

- "The Hint Cache"

- "Using Hint Rules"

- "Adding and Enabling New Hint Rules"

- "Editing Existing Hint Rules"

- "Disabling Hint Rules"

- "Enabling Hint Rules"

- "Removing Hint Rules"

- "Using the Query Converter"

- "Converting a Data Source"

- "Editing a Converted Data Source or Query"

- "Updating the Hint Cache"

- "Checking the Hint Cache from a Data Source"

- "Modifying an Existing Hint Cache Query Using Data Source"

- "Modifying an Existing Hint Cache Using a Query"

- "Removing a Hint Cache Data Source Entry"

- "Removing a Hint Cache Query"

3.4.6.1 About The Oracle Query Optimizer Component

Oracle database does not automatically select the best execution plan for certain types of user queries. To counter this, the Oracle Query Optimizer adds hints to queries that force Oracle database to perform searches more efficiently.

The hints are based on an intrinsic knowledge of Content Server's table data distribution and its index selectivity. To take advantage of this knowledge, Oracle Query Optimizer uses a pre-defined hint rules table to analyze the database query and then add appropriate hints to the query. In turn, the added hints improve Oracle's search performance.

Oracle Query Optimizer takes advantage of Content Server's data distribution in database tables and its index selection preferences. Based on these characteristics, the hint rules table included with Oracle Query Optimizer contains pre-defined rules. The feature uses these rules to analyze a database query and to add one or more appropriate hints to the query to optimize the search performance.

In very large collections containing millions of content items, Content Server generally has a difficult time selecting an appropriate optimization strategy to resolve even simple queries. To counteract this problem, Oracle Query Optimizer examines the submitted query and, based on its analysis, reformats the query by adding appropriate hints to optimize the search process. To add hints, the feature uses Content Server hints, The Hint Rules Table, and The Hint Cache.

3.4.6.2 Query Optimization Process

The stages of the optimization process are completed in the following sequence:

1. The submitted query is analyzed to verify if it contains one or more hints and, if so, determine the type of hint; see "Stage 1: Query Analysis".

2. If the query's WHERE clause does not contain a hint, the optimization feature must parse out the WHERE clause; see "Stage 2: Parsing".

3. After parsing, each condition in the query's WHERE clause is evaluated against the hint rules table in an attempt to qualify the condition and normalize the query; see "Stage 3: Normalization".

4. After the WHERE clause conditions are qualified and the query is normalized, a hint is selected or retrieved from the hint cache; see "Stage 4: Select Hint".

5. The query is reformatted using the selected hint; see "Stage 5: Reformat Query".

Figure 3-2 Optimization Process Sequence

3.4.6.2.1 Stage 1: Query Analysis

In this stage, a query is checked for both Oracle (native) and Content Server hints. This is determined based on the hint syntax: Query Hints Syntax. A query that contains Oracle hints is passed through. A query that contains Content Server hints bypasses Stage 2: Parsing and Stage 3: Normalization. If a query contains multiple Content Server hints, the best hint is chosen. Queries that do not contain any hints must be parsed and normalized.

3.4.6.2.2 Stage 2: Parsing

In this stage, a query that does not contain any hints is sent through the query parser and the WHERE clause is parsed out. A WHERE clause consists of one or more conditions joined with either AND or OR conjunctions. For each condition, the field name, operator, and field value are extracted. The AND/OR conjunctions of the clause are preserved; the parentheses are dropped. Conditions must use the following format:

fieldname operator value

For example, a properly formatted condition would be dID = 3. An incorrect condition would be 3 = dID.

3.4.6.2.3 Stage 3: Normalization

In this stage, normalization simplifies conditions, finalizes query operators, and provides a stable view of the WHERE clause for additional steps. The result of the normalization process produces a base for generating the cache key and the list of fields to use to search for hints.

Note:
To establish which database tables and columns have indexes, the hint rules table is defined on Content Server resources and on the running system.

- Qualifying WHERE Clause Conditions:
Each condition in the WHERE clause is checked against The Hint Rules Table. If a condition's field name is included in the hint rules table, then it is qualified and the condition is considered to be normalized. The condition contains its table name and alias. Then the normalized conditions are sorted to ensure that the same set of conditions is always listed consistently.

- Discarding WHERE Clause Conditions During Normalization:
During normalization, the following conditions are not considered relevant and are eliminated from further processing:

- Join conditions.

- Conditions that contain subqueries.

- Conditions whose field names do not have entries in the hint rules table and cannot be qualified.

- OR conditions that contain more than one field. For example:

(dSecurityGroup = 'Secure' or dDocAccount LIKE 'prj%')

- Conditions that contain the LIKE operator whose value begins with a wildcard.

- Reformatting WHERE Clause Conditions:
In the normalization step, the query conditions are rewritten to consolidate complex query conditions. OR conditions are reevaluated as follows:

- If all the fields are the same and all the operators are equal (or all the operators are LIKE and no values begin with a wildcard), the conditions are combined and changed to an IN query.

- If the fields are the same but have different operators, the conditions are combined and the generic operator is assigned.

- If the fields are different, the conditions are dropped.

For example, during normalization, the following condition is reformatted:

(dReleaseState = 'Y' OR dReleaseState = 'O")

It is reformatted as follows:

dReleaseState IN ('Y', 'O')

- Finding Potential Range Queries:
The parsed query is analyzed to find potential range queries that are then consolidated during the normalization process. For example, the conditions dIndate > date1 and dInDate < date2 are changed to one condition with the operator 'range'.

3.4.6.2.4 Stage 4: Select Hint

In this stage, the normalized conditions are checked against the hint cache. If one or more conditions have applicable hints in the cache, they are included. If applicable hints are not found in the cache, the conditions are analyzed and the preference orders are compared to determine the best possible hint.

3.4.6.2.5 Stage 5: Reformat Query

In this stage, the query is reformatted by adding in the selected hint. For more information about how reformatting queries with hints helps to optimize searches and some examples of reformatted queries, see "How Reformatted Queries Optimize Searches".

3.4.6.3 How Reformatted Queries Optimize Searches

The majority of queries in Content Server involve a small, targeted set of content items or return a hundred rows, at most. Content Server can easily scale to millions of content items. However, testing on an Oracle database with a collection containing 10 million content items indicates that the execution plan that Oracle selects is not the most efficient. Oracle generally does not choose the best optimization strategies to resolve many queries, even some that are trivial. The following examples explain this issue:

- "Example 1: Reformatting a Query by Adding a Single Hint"

- "Example 2: Reformatting a Query by Adding Multiple Hints"

3.4.6.3.1 Example 1: Reformatting a Query by Adding a Single Hint

In the environment described above, Oracle does not resolve the following query as efficiently as possible:

SELECT *
FROM Revisions, Documents, DocMeta
WHERE Revisions.dID = Documents.dID
AND Revisions.dID = DocMeta.dID
AND Revisions.dRevClassID = 333
Order By Revisions.dID

Because a fairly selective index is available (dRevClassID_2 for Revisions.dRevClassID), this query should access dRevClassID_2 and perform a sort on the rows that match the dRevClassID. However, in this query example, Oracle chooses to use the Revisions.dID index.

This choice is actually worse than performing a full table scan on the Revisions table because it does a full index scan and accesses the table to obtain the dRevClassID for each row. Obviously, resolving the query using this execution plan does not work well when the Content Server has over 10 million content items. In this case, it requires approximately 500 seconds to return the results.

However, the performance improves dramatically when the query is modified by adding a hint as follows:

SELECT /*+ INDEX(Revisions dRevClassID_2)*/ *
FROM Revisions, Documents, DocMeta
WHERE Revisions.dID = Documents.dID
AND Revisions.dID = DocMeta.dID
AND Revisions.dRevClassID = 333
Order By Revisions.dID

The query is modified by adding the following hint to the SELECT clause:

/*+ INDEX(Revisions dRevClassID_2)*/

This forces Oracle database to choose the dRevClassID_2 index instead of the index for Revisions.dID. Because no more than a few content items share dRevClassID in this example, the modified query returns the results instantly.

3.4.6.3.2 Example 2: Reformatting a Query by Adding Multiple Hints

In a typical content server instance, most documents have a 'Y' (released) status for the dReleaseState with a dInDate earlier than the current date. However, only a few documents have an 'N' (new, not yet indexed) status for the dReleaseState. The following query is searching for content items that have not yet been released:

SELECT dID
FROM Revisions
WHERE Revisions.dReleaseState = N'N' AND Revisions.dStatus in
(N'DONE', N'RELEASED', N'DELETED')
AND Revisions.dInDate<={ts '2005-02-23 17:46:38.321'}

The optimized result for the query uses the index for dReleaseState:

SELECT/*+ LEADING(Revisions) INDEX (Revisions dReleaseState)*/
dID
FROM Revisions
WHERE Revisions.dReleaseState = N'N' AND Revisions.dStatus in
(N'DONE', N'RELEASED', N'DELETED')
AND Revisions.dInDate<={ts '2005-02-23 17:46:38.321'}

3.4.6.4 Types of Recognized Hints

Content Server queries can be static queries defined in various resources, data sources with additional dynamic WHERE clauses, and dynamic queries that are ad-hoc or defined in the application such as Archiver. Static queries can be updated with Oracle database hints. However, it is nearly impossible to predefine hints for ad-hoc queries and dynamic WHERE clauses.

Content Server hints use a database-neutral hint syntax that supports multiple hints in the same query. A Content Server hint can be used in any query, data source, and WHERE clause. However, it cannot be combined with an Oracle database hint. If a query contains both types of hints, Oracle Query Optimizer will retain the Oracle database hint and ignore the Content Server hint.

3.4.6.5 Query Hints Syntax

During the optimization processing stages, Oracle Query Optimizer recognizes the distinct syntaxes of both types of hints and correspondingly processes the submitted query. For more detailed information, see the "Query Optimization Process".

3.4.6.5.1 Oracle Hint Syntax

An Oracle hint uses the following format:

/*+ hint */

For example:

/*+ Index(Revisions dID)*/

3.4.6.5.2 Content Server Hint Syntax

The Content Server hint syntax is database neutral and can support multiple Content Server hints in the same query. During the optimization process, Content Server hints are evaluated and the best hints are formatted and added back to the query.

During the optimization process, a query that includes one or more Content Server hints is not parsed. Only Content Server hints are considered when choosing indexes.

- Content Server Hint Syntax:
When a query undergoes the optimization process, Content Server hints are added to the reformatted query using the following syntax:

/*$tableName[ aliasName]:columnName[:operator [:<value>]][, …]*/

Where:

- Values enclosed in angle brackets (<value>) are required.

- Values enclosed in brackets ([value]) are optional.

- Ellipses (…) indicates a repetition of the previous expression(s).

- Query Before Optimization Process:

SELECT *
FROM Revisions, DocTypes, RoleDefinition
WHERE /*$Revisions:dStatus*/(Revisions.dStatus<>'DELETED' AND Revisions.dStatus<>'EXPIRED' AND Revisions.dStatus<>'RELEASED') AND Revisions.dDocType = DocTypes.dDocType AND /*$Revisions:dReleaseState*/Revisions.dReleaseState<>'E' AND (Revisions.dSecurityGroup = RoleDefinition.dGroupName AND RoleDefinition.dRoleName = ? AND RoleDefinition.dPrivilege > 0)

- Reformatted Query with Content Server Hints Added:
After the query has undergone the optimization process, both indexes are used and are added to the native indexes.

SELECT/*+ LEADING(revisions) INDEX (revisions dStatus dReleaseState)*/ *
FROM Revisions, DocTypes, RoleDefinition
WHERE (Revisions.dStatus<>'DELETED' AND Revisions.dStatus<>'EXPIRED' AND Revisions.dStatus<>'RELEASED') AND Revisions.dDocType = DocTypes.dDocType AND Revisions.dReleaseState<>'E' AND (Revisions.dSecurityGroup = RoleDefinition.dGroupName AND RoleDefinition.dRoleName = ? AND RoleDefinition.dPrivilege > 0)

3.4.6.6 Additional Supported Sort Constructs

Using Oracle sort constructs in search query clauses allows users greater flexibility when performing a query. Sort constructs specify the row data in two or more tables to be extracted, sorted, and combined. Essentially, the sort constructs serve the purpose of limiting the number of rows that are returned. Oracle Query Optimizer recognizes the following sort constructs:

- Group by: Sorts a set of records and specifies how to group the results.

- Order by: Sorts a set of records and specifies whether the results are to be returned in ascending or descending order.

- Inner join: Sorts a set of records by looking for and returning those that match.

- Outer join: Sorts a set of records by looking for and returning those that do not match.

3.4.6.7 The Hint Rules Table

The hint rules table contains the rules that the optimization feature uses to determine the proper hints to add to dynamic queries or data sources during the optimization process. Using the Hint Rule Editor, a hint rule can be defined for a particular field and operator. A hint rule can also be defined based on values or date/number ranges. The hint rule table is extensible by other components, and can be updated while the content server is running.

Figure 3-3 Example Hint Rules Table

Several default hint rules included with Oracle Query Optimizer are described in the following text. For more detailed descriptions of the table columns, see "Hint Rules Table Column Descriptions". The content of the hint rules table is available on the Hint Rules Configuration Page that is accessed through the Administration tray.

The hint rules table is scheduled to reload every night, and when a rule is added or modified. The hint value is recalculated at each reload.

Important:
Although the hint rules table includes a column allowing multiple indexes to be used with each other, in Oracle only the bitmap index can be combined. This is because the hint rules table was designed for core Content Server functionality.
Therefore, it might not be sufficient for a system with components that create additional tables or add additional metadata fields, or both. However, the hint rules table can be extended or overwritten by other components to provide knowledge of additional tables, indexes and fields.

- Explanation of First Hint Rule:
For this rule, if the WHERE clause contains the following condition the PK_Revisions index is used and added as a hint to the optimized query:

Revisions.dID = some_value

- Explanation of Second Hint Rule:
For this rule, if the WHERE clause contains either of the following conditions the dDocName index is used and added as a hint to the optimized query:

Revisions.dDocName = some_value
Revisions.dDocName LIKE 'some_value'

- Explanation of Third Hint Rule:
For this rule, if the WHERE clause contains the following condition the condition does not meet the requirements and cannot be qualified:

dStatus = 'DONE'

However, if the WHERE clause contains the following condition the dStatus index is used and added as a hint to the optimized query.:

dStatus = 'RELEASED'

3.4.6.8 Hint Rules Table Column Descriptions

This section describes the following columns in the hint rules table:

- Key

- Table

- Column

- Operators

- Index

- Order

- Values

- AllowMultiple

- Disabled

3.4.6.8.1 Key

This column contains the unique name to identify the rule. A component can use the unique key to overwrite a particular rule. This key is usually identical to its index name because the index name is unique in the same database schema.

By default, Oracle uses a B+ Tree (binary tree) as the indexing structure to provide efficient access to logical records. B+ Tree indexes are most useful for queries involving a small number of result rows or when the user needs to execute queries using varying criteria (such as equality and range conditions). Because B+ Tree indexes store the indexed data values, these indexes are useful as sources of data if the requested value is the stored value.

However, bitmapped indexes offer substantial performance improvements with minimal storage cost compared to the default B+ Tree indexes. Bitmapped indexes are particularly effective for searching columns with poor selectivity due to having very few distinct values. Also, a bitmap is built for each value including the NULL value (which means the NULL is indexed). Overall, using bitmapped indexes is very efficient because the index lookup process is a bit-level operation and allows access to multiple indexes.

Note:
Because hint rules can be overwritten, Oracle Query Optimizer does not allow you to add a hint rule using an existing key. Therefore, it is important when you are creating your bitmapped indexes for columns that you assign unique keys.

Oracle recommends that you use bitmapped indexes for the table columns listed below, and set the index name to the corresponding column name.

- Revisions table:

- dIndexerState

- dReleaseState

- dProcessingState

- dIsCheckedOut

- dSecurityGroup

- dStatus

- WorkflowDocuments table:

- dWfDocState

3.4.6.8.2 Table

This column identifies the specific database table.

3.4.6.8.3 Column

This column identifies the specific column within the database table listed in the Table column.

3.4.6.8.4 Operators

This column is a comma-delimited list of allowable operators. See the Operators field and menu on the Edit Query Hint Rules Table for more information about the valid operator options. The hint rule's operator is important in the decision of whether a hint rule will be applied to a condition.

For example, if the WHERE clause contains the following condition using the PK_Revisions index would be a very valuable hint to include in an optimized query:

Revisions.dID = 3

However, if the WHERE clause contains the following condition then using the PK_Revisions index would not be useful:

Revisions.dID > 3

3.4.6.8.5 Index

This column identifies the specific index to use in the optimized query if the condition meets the hint rule requirements.

3.4.6.8.6 Order

This column contains the preferred order to use when the rule is included in the hint rules table. The highest ordered rules in a query are given precedence when deciding which hint to use.

The order values include:

- 5: This value indicates that the specified index is unique or does not match more than 50 rows for any value. For example, specifying dID with the Revisions, Documents, or DocMeta tables.

- 4: This value indicates that the specified index should be somewhat less selective. The specified value should typically match a few rows and, at the very most, several hundred rows. For example, specifying dDocTitle with the Revisions table.

- 3: This value indicates that the specified index matches less than a thousand rows. For example, specifying dInDate or dOutDate.

- 2: This value indicates that the specified index matches less than ten thousand rows.

- 1: This value indicates that the specified index matches more than ten thousand rows.

3.4.6.8.7 Values

This column is Idoc scriptable. This column can only be defined when the Operators column value is one of the following:

- in or notIn: When you use either of these operators, the value should be a comma-delimited list enclosed in parenthesis.

- range: When you use this operator, the value must use one of the following formats:

- Format 1:

([<lowValue>],range[,<highDateValue>])

Examples of acceptable values include:

('Y', 'O')
(,7d)
({ts '2004-12-11 12:03:23.000'}, 2d, <$dateCurrent()$>)

- Format 2:

#[d|h]

For example, a range of five days is 5d and seven hours is 7h.

Tip:
The operators in or notIn can substitute for the operators equal and notEqual, respectively, along with their matching values. For more information about operator options, see the Operators field and menu on the Hint Rule Editor.

The following use cases demonstrate how this column provides additional flexibility to the hint rules:

- Use Case 1: State or Status Table Columns
Table columns that indicate a state or status such as dReleaseState or dStatus are biased regarding the finished states. For example, dReleaseState is predisposed for 'Y' (released) or 'O' (old version). Likewise, dStatus is predisposed for RELEASED. Therefore, in WHERE clauses, conditions such as dReleaseState = Y or dStatus = RELEASED match the majority of rows in the Revisions table. Thus, indexes for these two columns are almost useless. Conversely, the condition dReleaseState = N (new, not yet indexed) matches only a few rows. Consequently, indexes on this column would be very helpful.

- Use Case 2: Date or Number Table Columns
Table columns that indicate a date or number exhibit similar behavior to state or status. For example, the condition dInDate < <$dateCurrent()$> matches most of the table rows and makes indexes on this field irrelevant. However, the combined conditions dInDate < <$dateCurrent()$> AND dInDate > <$dateCurrent(-1)$> usually match only a small set of rows and would benefit from using the corresponding index as a hint.

3.4.6.8.8 AllowMultiple

This column indicates whether the defined index is used with other indexes. In Oracle, only the bitmap index can be combined.

3.4.6.8.9 Disabled

This column indicates whether a hint rule has been disabled. Any rule in the table can be enabled/disabled. If you disable a hint rule, a value of 'Y' is displayed. Existing rules can be disabled to match the current Content Server state.

For example, if a Content Server instance contains only a few distinct content revClasses, each revClass may have thousands of revisions. Therefore, the dRevClass_2 index is not very effective. In this case, this corresponding hint rule should be disabled and you should add one or more new rules with different preference orders.

Note:
Although any rule in the table can be enabled/disabled, only the rules that are added using the Hint Rule Editor can be removed. The default hint rules that are included with the Oracle Query Optimization feature can only be disabled; they cannot be removed.

3.4.6.9 Hint Rule Editor

The Hint Rule Editor provides a way to add, remove, enable, or disable rules using the Edit Query Hint Rules Table. You can add a new rule to reflect new tables and indexes. Existing rules can be removed or disabled to match the current state of Content Server. If you select a hint rule from the hint rule table, the Hint Rule Editor fields are automatically populated with the applicable values.

The Edit Query Hint Rules Table is accessed by clicking one of the Show hint rule editor toggles on the Hint Rules Configuration Page and is displayed below the hint rules configuration table.

The hint rules configuration table is scheduled to reload every night and whenever a new rule is added or an existing rule is modified. The hint value is recalculated at each reload.

Although any rule in the table can be enabled/disabled, only the rules that are added through the Hint Rule Editor can be removed. The default hint rules that are included with the Oracle Query Optimizer component can only be disabled; they cannot be removed.

3.4.6.10 The Hint Cache

Oracle Query Optimizer also contains a hint cache to store dynamically generated hints. For example, a hint derived from a parsed query or data source is cached to maintain persistence. In this way, the hint cache provides stability for queries and data sources.

The hint cache is used during the optimization process to select hints for queries that do not contain Oracle or Content Server hints. The hint cache provides a mechanism to fine tune query hints. In addition, administrator can check/edit cache and change hint for queries at run time.

The hint cache is stored to disk every two hours and is reloaded when the content server instance is started.

The characteristics of the hint cache include:

- Reusing Hint Cache Entries

- Hint Cache Management

- Default Capacity Algorithm

- Origin of Hint Cache Keys

- Hint Cache Persistence

3.4.6.10.1 Reusing Hint Cache Entries

The same query matches the same cache entry regardless of its values unless the new value does not satisfy the hint rule conditions. Two examples are included below to demonstrate how the same hint cache entry can and cannot be used for multiple queries.

Example 1: Using Similar Hint Cache Entries

In the following two queries, the same hint cache entry is used because both queries match the hint rule requirements.

- QueryA:

SELECT *
FROM Revisions
WHERE dDocName = 'name1'

- QueryB:

SELECT *
FROM Revisions
WHERE dDocName = 'name2'

Example 2: Using Different Hint Cache Entries

In the following two queries, the same hint cache entry cannot be used because QueryB violates the requirements for the dReleaseState hint rule. The dReleaseState hint rule requires that the dReleaseState values are neither Y (released) nor O (old revision).

- QueryA:

SELECT *
FROM Revisions
WHERE dReleaseState = 'U' AND dStatus = 'DONE'

- QueryB:

SELECT *
FROM Revisions
WHERE dReleaseState = 'Y' AND dStatus = 'DONE'

3.4.6.10.2 Hint Cache Management

In the hint cache, you can add a new entry, edit an existing entry, or remove an existing entry using the Hint Cache Updater Page. When adding or editing hint cache entries, you must use the Content Server Hint Syntax. The ability to manage the hint cache is very useful for fine tuning query hints. The example below demonstrates the benefits of fine tuning a hint cache entry.

Example: Batchloading Unindexed Content

If you have just batchloaded 100K content items into the Content Server and they are not yet indexed, the index-based query used above (Example 2: Using Different Hint Cache Entries) would match all of the batchloaded documents.

- QueryA:
If most of the batchloaded documents have not been indexed, the dReleaseState index that is used in this query is not the best choice. For the best results in this case, you should fine tune the hint cache entry to use both the dReleaseState and the dStatus indexes. Use the Hint Cache Updater Page to update hint cache entries.

SELECT dID
FROM Revisions
WHERE Revisions.dReleaseState = N'N' AND Revisions.dStatus in (N'DONE', N'RELEASED', N'DELETED') AND Revisions.dInDate<={ts '2005-02-23 17:46:38.321'}

- QueryB:
After updating the hint cache entry, the new optimized query is:

SELECT/*+ LEADING(revisions) INDEX (revisions dReleaseState dStatus)*/ dID
FROM Revisions
WHERE Revisions.dReleaseState = N'N' AND Revisions.dStatus in (N'DONE', N'RELEASED', N'DELETED') AND Revisions.dInDate<={ts '2005-02-23 17:46:38.321'}

3.4.6.10.3 Default Capacity Algorithm

By default, the hint cache has a maximum capacity of 1000 hints. The hint cache uses the midpoint insertion least-recently-used (LRU) algorithm which is similar to the one used by Oracle and mySQL. A new entry is inserted into the middle of the queue and each subsequent execution moves the entry up one spot.

When the number of hints in the cache exceed the maximum capacity, the entry at the bottom of the queue is removed from the cache. Thus, the LRU algorithm ensures that the most recently executed query hints are in the upper levels of the queue.

3.4.6.10.4 Origin of Hint Cache Keys

The hint cache key is generated from the normalized query; see "Stage 3: Normalization". It consists of the qualified columns (columns that are qualified by table/alias names) and columns that have a hint rule defined. The cache key excludes conditions that contain joins or subqueries.

The following example illustrates how the cache key is generated from a given query:

SELECT DocMeta.*, Documents.*, Revisions.*
FROM DocMeta, Documents, Revisions
WHERE DocMeta.dID = Revisions.dID AND Revisions.dID=Documents.dID AND Revisions.dDocName='abc' AND Revisions.dStatus<>'DELETED' AND (Revisions.dReleaseState='U' OR Revisions.dReleaseState='I' OR Revisions.dReleaseState='Y') AND Documents.dIsPrimary<>0

The generated cache key is as follows:

documents.disprimary:notequal:documents|revisions.ddocname:equal:revisions|revisions.dreleasestate:in:revisions|revisions.dstatus:notequal:revisions

3.4.6.10.5 Hint Cache Persistence

The hint cache is designed to be persistent. To ensure the persistence, the hint cache is saved to the file system every two hours. The persisted hint cache is reloaded when the content server instance is started.

3.4.6.11 Using Hint Rules

The following tasks are involved in using hint rules:

- Adding and Enabling New Hint Rules

- Editing Existing Hint Rules

- Disabling Hint Rules

- Enabling Hint Rules

- Removing Hint Rules

To access the Hint Rules Configuration page:

1. Open the Administration tray.

2. Click the Hint Rules Configuration link.
The Hint Rules Configuration Page is displayed.

3. Click the Show hint rule editor toggle switch on the Hint Rules Configuration page.
The Edit Query Hint Rules Table is displayed.

3.4.6.11.1 Adding and Enabling New Hint Rules

To add a new hint rule to the hint rules table:

1. Click the Show hint rule editor toggle switch on the Hint Rules Configuration page.
The Edit Query Hint Rules Table is displayed.

2. Complete the fields as desired. For more detailed explanations of each field, see "The Hint Rules Table" and the "Edit Query Hint Rules Table".

3. Click the Add button.
The new hint rule is added to the hint rules table and is effective immediately.

3.4.6.11.2 Editing Existing Hint Rules

To edit an existing hint rule in the hint rules table:

1. Select the desired hint rule in the hint rules table.
The Edit Query Hint Rules Table is displayed and all of the applicable fields are populated with the hint rule's values.

2. Edit the fields as desired. For more detailed explanations of each field, see "The Hint Rules Table" and the "Edit Query Hint Rules Table".

3. Change the key.

4. Click the Add button.
The hint rules table is refreshed and the new hint rule is added. The modifications are effective immediately.

5. Delete the old hint rule.

3.4.6.11.3 Disabling Hint Rules

Although any rule in the table can be enabled/disabled, only the rules that are added through the Edit Query Hint Rules Table can be removed. The default hint rules that are included with the Oracle Query Optimization feature can only be disabled; they cannot be removed.

To disable a hint rule in the hint rules table:

1. Select the desired hint rule in the hint rules table.
The Edit Query Hint Rules Table is displayed and all of the applicable fields are populated with the hint rule's values.

2. Click the Disable button.
The hint rules table is refreshed and 'Y' is displayed in the Disabled column indicating that the hint rule is deactivated.

3.4.6.11.4 Enabling Hint Rules

Although any rule in the table can be enabled/disabled, only the rules that are added through the Edit Query Hint Rules Table can be removed. The default hint rules that are included with the Oracle Query Optimization feature can only be disabled; they cannot be removed.

To enable a disabled hint rule in the hint rules table:

1. Select the desired hint rule in the hint rules table.
The Edit Query Hint Rules Table is displayed and all of the applicable fields are populated with the hint rule's values.

2. Click the Enable button.
The hint rules table is refreshed and the Disabled column is clear indicating that the hint rule is reactivated.

3.4.6.11.5 Removing Hint Rules

Although any rule in the table can be enabled/disabled, only the rules that are added through the Edit Query Hint Rules Table can be removed. The default hint rules that are included with the Oracle Query Optimization feature can only be disabled; they cannot be removed.

To delete a hint rule from the hint rules table:

1. Select the desired hint rule in the hint rules table.
The Edit Query Hint Rules Table is displayed and all of the applicable fields are populated with the hint rule's values.

2. Ensure that the hint rule is enabled. If the hint rule is disabled it cannot be removed. To reactivate a disabled hint rule, see "Enabling Hint Rules".

3. Click the Remove button.
The hint rules table is refreshed and the selected hint rule is removed.

3.4.6.12 Using the Query Converter

The following tasks are involved when you use the Query Converter:

- Converting a Data Source

- Converting a Query

- Editing a Converted Data Source or Query

To access the Query Converter page, select Administration, then Oracle Query Optimizer, then click Query Converter.

3.4.6.12.1 Converting a Data Source

To convert a data source query.

1. If applicable, select the Use Data Source check box.
The data source-related fields are displayed on the Query Converter page.

2. Select the desired data source from the DS Name menu.
The data source query is displayed in below the DS Name field.

3. Enter the applicable information for additional parameters and WHERE clauses.

4. Click Convert Query.
The data source is converted and the results are displayed in a text area above the Use Data Source check box. To view an example of a converted data source query, see Figure 3-4.

3.4.6.12.2 Converting a Query

To convert a query:

1. If applicable, clear the Use Data Source check box.
The data source-related fields are hidden from the Query Converter page.

2. Enter the applicable information for the query.

3. Click Convert Query.
The query is converted and the results are displayed in a text area above the Use Data Source check box. To view an example of a converted query, see Figure 3-5.

Figure 3-4 Example of Converted Data Source Screen

Figure 3-5 Example of Converted Query Screen

3.4.6.12.3 Editing a Converted Data Source or Query

After the data source or query is converted, the results are displayed above the Use Data Source check box. Because the conversion process clears the fields, the converted query can only be modified by entering new information in the fields. To edit information for a data source or query, see the applicable sections in "Converting a Data Source".

3.4.6.13 Updating the Hint Cache

The following tasks are involved when updating the hint cache:

- Accessing the Hint Cache Updater Page

- Checking the Hint Cache from a Data Source

- Checking from a Query

- Modifying an Existing Hint Cache Query Using Data Source

- Modifying an Existing Hint Cache Using a Query

- Removing a Hint Cache Data Source Entry

- Removing a Hint Cache Query

3.4.6.13.1 Accessing the Hint Cache Updater Page

To access the Hint Cache Updater page, select Administration, then Oracle Query Optimizer, then click Hint Cache Updater.

3.4.6.13.2 Checking the Hint Cache from a Data Source

To check the hint cache using a data source:

1. On the Hint Cache Update page, select the Use Data Source check box.
The data source-related fields are displayed on the Hint Cache Updater page.

2. Select the desired data source from the DS Name menu.
The data source query is displayed in below the DS Name field.

3. Enter the applicable information for the additional parameters, WHERE clause, and hints.

4. Click Check Cache.
The results are displayed above the Use Data Source check box. To view an example of an unsuccessful hint search, see Figure 3-6.

Figure 3-6 Example of Hint Cache Updater Results with Data Source

3.4.6.13.3 Checking from a Query

To check the hint cache using a query:

1. On the Hint Cache Update page, ensure the Use Data Source check box is clear.
The data source-related fields are hidden from the Query Converter page.

2. Enter the applicable information.

3. Click Check Cache.
The results are displayed above the Use Data Source check box. To view an example of an unsuccessful hint search, see Figure 3-7. To view an example of a successful hint search, see Figure 3-8.

Figure 3-7 Example of Hint Cache Updater Results without Data Source

Figure 3-8 Hint found in hint cache

3.4.6.13.4 Modifying an Existing Hint Cache Query Using Data Source

To modify a hint cache query using a data source:

1. On the Hint Cache Updater page, select the Use Data Source check box.
The data source-related fields are displayed on the Hint Cache Updater page.

2. Select the desired data source from the DS Name menu.
The data source query is displayed in below the DS Name field.

3. Enter the applicable information for the additional parameters, WHERE clause, and hints.

4. Click Update Cache to overwrite the previous hint cache.
The results are displayed in a text box above the Use Data Source check box. To see an example of successfully adding a new hint to a query and updating the hint cache, see the screen capture included in this section.

3.4.6.13.5 Modifying an Existing Hint Cache Using a Query

To modify a hint cache using a query:

1. On the Hint Cache Page, ensure that the Use Data Source check box is clear.
The data source-related fields are hidden from the Query Converter page.

2. Enter the applicable information.

3. Click Update Cache to overwrite the previous hint cache.
The results are displayed above the Use Data Source check box. In the screen capture note that the new hint was added and the hint cache was updated.

Figure 3-9 New hint added, hint cache updated

3.4.6.13.6 Removing a Hint Cache Data Source Entry

To remove a hint cache data source entry:

1. On the Hint Cache Updater page, select the Use Data Source check box.
The data source-related fields are displayed on the Hint Cache Updater page.

2. Select the desired data source from the DS Name menu.
The data source query is displayed below the DS Name field.

3. Enter the applicable information for the additional parameters, WHERE clause, and hints.

4. Click Remove.
The information entered into the fields is removed. To see an example of successfully removing a hint from a query and the hint cache, see the screen capture included in this section.

3.4.6.13.7 Removing a Hint Cache Query

To remove a hint cache query:

1. On the Hint Cache Updater page, ensure that the Use Data Source check box is clear.
The data source-related fields are hidden from the Query Converter page.

2. Enter the applicable information for the query and hints.

3. Click Remove.
The results are displayed above the Use Data Source check box. In the screen capture note that the previously added hint was deleted from the query and hint cache.

Figure 3-10 Example of a deleted hint from cache

3.5 Configuring a File Store System

This section contains the following topics:

- "Introduction to File Store Provider"

- "Configuring File Store Provider"

- "File Store Provider Resource Tables"

- "File Store Provider Sample Implementations"

3.5.1 Introduction to File Store Provider

With the release of version 11gR1, Content Server implemented a file store system for data management, replacing the traditional file system for storing and organizing content. The File Store Provider component is installed (enabled) by default with Content Server deployment. File Store Provider exposes the file store functionality in the Content Server interface and allows additional configuration options. For example, you can configure Content Server to use binary large object (BLOB) data types to store content in a database, instead of using a file system. This offers several advantages:

- Integrates repository management with database management for consistent backup and monitoring processes.

- Helps overcome limitations associated with directory structure and number of files per directory in a file system approach.

- Aids in distributing content more easily across systems, for better scaling of Content Server.

- Allows for different types of storage devices not commonly associated with a file system, for example, content addressed storage systems and write-only devices necessary in some business uses.

Caution:
The File Store Provider component is installed and enabled by default during Content Server deployment. It should not be uninstalled or disabled after the default file store is upgraded. If you have not yet upgraded the default file store, you can disable the component following the procedure in "Enabling and Disabling a Component".

This section contains the following topics:

- "Data Management"

- "File Store Provider Features"

3.5.1.1 Data Management

Content Server manages content by tracking the storage of electronic files and their associated metadata. It provides the ability for users to store and access their checked in files, any associated information, and any associated renditions. This section discusses the data management methods historically used by Content Server and how they are addressed with the File Store Provider component.

- "File Management"

- "Metadata Management"

- "File Stores"

3.5.1.1.1 File Management

The first half of data management is storing electronic files checked into Content Server. With Content Server, file storage has typically been done with a traditional file system, storing electronic files in a hierarchical directory structure that includes vault and weblayout directories. By using the revision information specified by the content type, security group and account (if used), files and their associated renditions are placed into particular directories within the vault and weblayout directories. For example, the primary and alternate files specified at check in are stored in subdirectories in the vault directory. The specific file location is defined to be the following:

IntradocDir/vault/dDocType/account/dID.dExtension

In this path name, dDocType is the content type chosen by the user on check in, dID is the unique system-generated identification that identifies this revision, and dExtension is the extension of the file checked in. In this hierarchical model, the system uses the dDocType metadata field to distribute the files within the hierarchy established in the vault directory. Similarly, any web rendition is distributed across the hierarchy within the IntradocDir/weblayout/groups/ directory. The web rendition is the file served out of a Web server, and in the historical file system storage method, could be the native file, the alternate file, or a web-viewable file generated by Inbound Refinery or some other conversion application.

This straightforward determination of file storage location is helpful to component and feature writers, helping them understand where files are located and how to manipulate them. However, it also has the effect of limiting storage management. Without careful management of the location metadata, directories can become saturated, causing the system to slow down.

3.5.1.1.2 Metadata Management

The second half of data management is storing metadata associated with an electronic file. With Content Server, metadata management has typically been done using a relational database, primarily involving three database tables. Metadata enables users to catalogue content and provides a means for creating file descriptors to facilitate finding it within Content Server. For users, the retrieval is done by the Content Server, and how and where the file is stored may be completely hidden. For component and feature writers, who may need to generate or manipulate files, the metadata provides a robust means of access.

3.5.1.1.3 File Stores

The traditional file system model historically used by Content Server limits scalability. As data management needs grow, adding extra storage devices to increase storage space is not conducive to easy file sharing through a Web-based interface. Complex, nested file structures could slow performance. Suppressing the creation of a duplicate web-viewable file when the native file format could be used could be difficult. As a consequence of dealing with large systems, for example over 100 million content items, Content Server has shifted to using a file store. This offers the advantages of scalability, flexibility, and manageability.

3.5.1.2 File Store Provider Features

The File Store Provider component enables you to define data-driven rules to store and access content managed by the Content Server. File Store Provider offers the following features:

- The ability to relocate files easily.

- The ability to have the web-viewable file be optional.

- The ability to manage and control directory saturation.

- The ability to integrate with third-party storage devices.

- An API to use, extend, and enhance different storage paradigms.

With File Store Provider, checked-in content and associated metadata are examined and assigned a storage rule based on criteria established by a system administrator. Criteria can include metadata, profiles, or other considerations. The storage rule determines how vault and web files are stored by Content Server and how they are accessed by a Web server.

3.5.2 Configuring File Store Provider

A file store for data management is now used in Content Server instead of the traditional file system for storing and organizing content. Using the File Store Provider component, the system administrator can upgrade the default file store to make use of functionality exposed by the component. After the default file store is upgraded, the web, vault and web URL path expressions can be modified.

Note:
After the default file store is upgraded, the vault path in the default storage rule is set to $PartitionRoot$. A value for $PartitionRoot$ does not exist until you create a partition. Partitions are not required to run Content Server, but any attempt to check in content before creating a partition, changing the vault path root, or creating a new, well-formed storage rule will fail. See "Understanding File Store Provider Storage Principles", including the sections on storage rules and path construction for additional information.

Note:
Oracle WebLogic Server does not support configuring its Web server for Content Server to add a new virtual directory and alias to point to the weblayout directory for each partition that is created.While partitions can be used for the vault files, in 11g Release 1 (11.1.1) partitions are not supported for web files.

Caution:
Resource files should not be edited directly. Proper modification of resource files should be done within the Content Server user interface or through additional component development. For more information on component development, see Chapter 5, "Working With Components".

Three other resource tables are used to define and handle file paths. The defaults for the PathMetaData Table and PathConstruction Table cover most scenarios. The StorageRules Table stores the values specified when a storage rule is defined. These three tables are provider-specific, and as such are defined in the provider.hda file of the defaultfilestore directory. The defaultfilestore directory is located in the IntradocDir/data/providers/ directory. A fourth table, the FileSystemFileStoreAlgorithmFilters Table requires a component along with java code to modify.

This section contains the following topics:

- "Using Standard Content Server Variables"

- "Working with File Store Provider"

- "Understanding File Store Provider Storage Principles"

3.5.2.1 Using Standard Content Server Variables

The File Store Provider component makes several modifications to the Content Server database, Content Server metadata fields, and other configuration files, allowing for possible configuration options.

This section contains the following topics:

- "Database Options"

- "Content Server Options"

3.5.2.1.1 Database Options

In some situations, content stored in a database may have to be forced onto a file system. One example would be when Inbound Refinery must have access to a file for conversion. Files forced onto a file system are considered temporary cache. The following configuration values are used to control when the temporarily cached files are to be cleaned up. Note that the system only cleans up files that have an entry in the FileCache Table.

Variable

Description

FsCacheThreshold

Specifies the maximum cache size, in megabytes (default=100). When the threshold is met, Content Server starts deleting files that are older than the minimum age, as specified by the FsMinimumFileCacheAge parameter.

FsMaximumFileCacheAge

The age at which files are deleted, expressed in days. The default is 365.

FsMinimumFileCacheAge

The minimum age at which cached files can be deleted. This parameter is used in conjunction with the FsCacheThreshold parameter to determine when to delete cached files.

3.5.2.1.2 Content Server Options

File Store Provider adds several Content Server metadata fields and makes additional options available for use in configuration files.

This section contains the following topics:

- "Configuring Added Metadata Fields"

- "Setting the Default Storage Directory"

- "Standard File Store Provider Variables"

Configuring Added Metadata Fields

File Store Provider adds three metadata fields to Content Server:

- xPartitionId: This metadata field is used in conjunction with the PartitionList table to determine the root location of the content item files. It is recommended that this field be hidden on the UI, since the partition selection algorithm provides a value.

- xWebFlag: This metadata field is used to determine whether a content item has a web-viewable file. Consequently, if the system has content items that have only vault files, then removing this metadata field causes the system to expect the presence of a web-viewable and may cause harm to the system. The metadata field may be specified by the configuration value WebFlagColumn.

- xStorageRule: This metadata field is used to track the rule that was used to determine how the file is to be stored. The metadata field may be specified by the configuration value StorageRuleField.

Note:
These metadata fields are added by File Store Provider on startup, and if deleted, are added again when Content Server restarts. If the metadata fields must be permanently deleted, set the configuration variable FsAddExtraMetaFields=false in the intradoc.cfg file to disable the automatic creation of the fields. The intradoc.cfg file is located in the DomainHome/ucm/cs/bin directory.

Setting the Default Storage Directory

A StorageDir parameter may be set equal to a root directory, used for all partitions where the PartitionRoot column value has not been specified. In this case the storage directory and the partition name is used to create the PartitionRoot parameter. The StorageDir parameter is set in the intradoc.cfg file, located in the DomainHome/ucm/cs/bin directory.

Standard File Store Provider Variables

In the provider.hda located in the IntradocDir/data/providers/defaultfilestore directory, the following parameters and classes are standard for a file system store:

ProviderType=FileStore
ProviderClass=intradoc.filestore.BaseFileStore
IsPrimaryFileStore=true
# Configuration information specific to a file system store provider.
ProviderConfig=intradoc.filestore.filesystem.FileSystemProviderConfig
EventImplementor=intradoc.filestore.filesystem.FileSystemEventImplementor
DescriptorImplementor=intradoc.filestore.filesystem.FileSystemDescriptorImplementor
AccessImplementor=intradoc.filestore.filesystem.FileSystemAccessImplementor

3.5.2.2 Working with File Store Provider

When the File Store Provider default file store is upgraded, checked-in content and associated metadata are examined and assigned a storage rule based on criteria established by the system administrator. Criteria can include metadata, profiles, or other considerations. The storage rule determines how vault and web files are stored and accessed by Content Server and how they are accessed by a Web server. Files can be stored in a database or placed on one or more file systems or storage media. Partitions can be created to help manage storage location, but are not required.

This section covers the following topics:

- "Upgrading the Default File Store"

- "Adding or Editing a Partition"

- "Editing the File Store Provider"

- "Adding or Editing a Storage Rule"

3.5.2.2.1 Upgrading the Default File Store

The system administrator can upgrade the default file store to make use of functionality exposed by File Store Provider. After the default file store is upgraded, the web, vault and web URL file path expressions can be modified.

Caution:
File Store Provider should not be disabled after the default file store has been upgraded. If you have not yet upgraded the default file store, you can disable the component following the procedure in "Enabling and Disabling a Component".

To upgrade the default file store, perform these steps:

1. Log in to Content Server as a system administrator.

2. Open the Administration tray and click Providers. The Providers Page is displayed.

3. Click Info in the Action column next to the DefaultFileStore provider. The FileStore Provider Information Page is displayed.

4. Click Upgrade. The Edit File Store Provider Page is displayed.

5. Click Update to submit the change. The Providers Page is displayed.

Note:
Do not navigate away from the Edit File Store page before clicking Update to submit the change. If you do not update, the upgraded file store provider will not be in effect.

6. Restart Content Server.

3.5.2.2.2 Adding or Editing a Partition

You can create partitions to define additional root paths to files managed by Content Server but requiring storage in different locations or on different types of media. You create partitions using the Partition Listing Page. When a new partition is created, Content Server modifies the PartitionList resource table in the fsconfig.hda file, located in the IntradocDir/data/filestore/config/ directory.

Note:
Oracle WebLogic Server does not support configuring its Web server for Content Server to add a new virtual directory and alias to point to the weblayout directory for each partition that is created. While partitions can be used for the vault files, in 11g Release 1 (11.1.1) partitions are not supported for web files.

To add a partition to Content Server, perform these steps:

1. Open the Administration tray and click File Store Administration.

2. If there are no partitions defined, click Add Partition. Otherwise, the Add/Edit Partition Page is displayed.

3. Enter a partition name. The name must be unique.

4. Modify the partition root, duplication methods, and any other pertinent parameters. See Add/Edit Partition Page for more information.

5. Ensure that Is Active is enabled.

6. Click Update. The Partition Listing Page is displayed.

3.5.2.2.3 Editing the File Store Provider

You may edit the default file store provider at any time. To edit the file store, perform these steps:

1. Log in to Content Server as a system administrator.

2. Open the Administration tray and click Providers. The Providers Page is displayed.

3. Click Info in the Action column next to the DefaultFileStore provider. The FileStore Provider Information Page is displayed.

4. Click Edit. The Edit File Store Provider Page is displayed.

5. Make the necessary modifications and click Update to submit the changes. The Providers Page is displayed.

Note:
Do not navigate away from the Edit File Store page before clicking Update to submit the change.

6. Restart Content Server.

3.5.2.2.4 Adding or Editing a Storage Rule

You may add multiple storage rules to the file store.

Important:
Storage rules cannot be deleted. Carefully consider each storage rule before you create it.

Caution:
Changing a storage rule after content has been checked in to Content Server may cause Content Server to lose track of the content.

To add or edit storage rules, perform these steps:

1. Log in to Content Server as a system administrator.

2. Open the Administration tray, and click Providers. The Providers Page is displayed.

3. Click Info in the Action column next to the DefaultFileStore provider. The FileStore Provider Information Page is displayed.

4. Click Edit. The Edit File Store Provider Page is displayed.

5. Select Add new rule, or select the name of the rule to edit from the Storage choice list, and click Edit rule. The Add/Edit Storage Rule Page is displayed.

6. Make the necessary modifications to the storage rule, and click OK. The Edit File Store Provider Page is displayed.

7. Click Update. The Providers Page is displayed.

Important:
If the Web root used in the web URL file path defined in the storage rule is something other than the default weblayout directory defined for Content Server, you must add an alias or virtual directory in your Web server for the Web root used in the storage rule. Otherwise, Content Server does not know where to access the file. For information on adding virtual directories to your Web server, see the documentation that came with your Web server.

3.5.2.3 Understanding File Store Provider Storage Principles

When a content item is checked in to Content Server, it consists of metadata, a primary file selected by the user, and potentially an alternate file. The alternate file may also be selected and checked in by the user, and is presumed to be a web-viewable file. In a file system approach to Content Server, the primary file is stored in the vault directory at the root of the DomainHome directory and is called the native file. If an alternate file is checked in, it is also stored in the vault, but is copied to the weblayout directory or passed to a conversion application, such as Inbound Refinery. If no alternate file is checked in, then the native file is copied from the vault directory to the weblayout directory, existing in two places. If no alternate file is checked in and Inbound Refinery is installed, a rendition of the native file could be created and stored in weblayout directory.

In a file system approach to Content Server, storing content in specified directories defines a path to the content. You can access content from a browser by using a static web URL file path, when you know the content is in a specific location, or using a dynamic Content Server service request, such as GET_FILE, when you do not. With File Store Provider, content may or may not be stored in a file system. Consequently, a new approach to defining paths to the content must be taken.

Depending on how you set up File Store Provider, you may or may not have a static web URL. By using a dynamic Content Server service request, you can access content when you do not know the specific location. With File Store Provider, the static web URL is defined as the web URL file, and the dynamic access is simply called the web URL. On the File Store Provider user interface, you can configure only the static web URL file path. However, you can decide to have the static web URL done as a Content Server service request, essentially making it dynamic.

This section covers the following topics:

- "Using Storage Rules on Renditions to Determine Storage Class"

- "Understanding Path Construction and URL Parsing"

3.5.2.3.1 Using Storage Rules on Renditions to Determine Storage Class

When content is checked in, all versions of the content managed by Content Server are considered renditions. These renditions include the native file, web-viewable file, and any other files that may have been rendered by Inbound Refinery or third-party conversion applications.

Renditions are grouped together into a storage class, which determines where and how a rendition is accessed. Storage classes are grouped together into a storage rule, which defines the vault, web, and web URL path expressions, through a storage class. Additionally, a storage rule determines if a rendition is not stored, as in a web-less file store, or if it is stored in a different device, such as a database rather than a file system.

The following examples illustrate how storage rules can determine where and how different content items can be stored.

Example 1:

A storage rule is defined as File system only on the Add/Edit Storage Rule Page and the Is Webless File Store is disabled. In this scenario, the system makes a copy of the primary files and places them in the weblayout directory.

This traditional file system storage example typically offers the advantage of faster access time to content when compared with database storage. This advantage diminishes if the file system hierarchy is complex or becomes saturated, or as the quantity of content items increases.

Example 2:

A storage rule is defined as File system only on the Add/Edit Storage Rule Page and the Is Webless File Store is enabled. In this scenario, no copy is made of the primary files and so the native files are the only renditions. Requests for web-viewable files are routed to the native files stored in the vault.

Note:
The web-less option of FileStoreProvider can specify that no web rendition be created. When this is used in conjunction with Inbound Refinery, a web rendition is always created and stored in either the file system or the database, depending on the storage rule in effect.

This traditional file system storage example, like the previous one, offers the advantage of faster access time to content. It also saves on storage space by not copying a version of the content from the vault directory to the weblayout directory. Instead, it redirects web-viewable access to the content in the vault directory. This is useful if most of the native files checked in are in a web-viewable format, or if Content Server is being used to manage content that is not required to be viewed in a browser.

Example 3:

A storage rule is defined as JDBC Storage on the Add/Edit Storage Rule Page and no selection is made from the Renditions choice list. In this scenario, both the vault and web files are stored in the database.

This database storage example offers the advantage of integrating repository management with database management for consistent backup and monitoring processes, and helps overcome limitations associated with directory structure and number of files per directory in a file system approach.

Important:
When necessary, content items stored in a database can be forced onto the file system, for example, during indexing or conversion. The files on the file system are treated as temporary cache and deleted following the parameters specified in the config.cfg file located in the IntradocDir/config directory. For more information on the parameters used, see FileCache Table.

Example 4:

A storage rule is defined as JDBC Storage on the Add/Edit Storage Rule Page and Web Files is selected from the Renditions choice list. In this scenario, the vault files are stored in the database and the web files are permanently stored on the file system.

This mixed approach of storing native files in a database but web-viewable files on a file system offers the advantages of database storage in the previous example (integrated backup and monitoring, overcoming file system limitations) for the native files, while providing speedy web access to web-viewable renditions. Like the first example, this advantage can be diminished if the file system structure is overly complex, or the quantity of files is extreme.

3.5.2.3.2 Understanding Path Construction and URL Parsing

The path to content stored in Content Server is defined in the PathExpression column of the PathConstruction Table. Paths are made up of pieces, with each piece separated by a slash (/). Each piece can be made of a static string or a sequence of dynamic parts. A dynamic part is encapsulated by a dollar sign ($). A part may be calculated using an algorithm, Idoc Script variable, environment variable or a metadata lookup, and can have the following interpretations:

- It may be a field defined in the PathMetaData table. If it is defined in the PathMetaData table, it may be mapped to an algorithm, for example, $dDocType$.

- If it has the prefix #env., it is an environment variable, for example, $#env.VaultDir$.

- It may be an Idoc Script variable, for example, $HttpWebRoot$.
For example, the standard vault location is defined as

$PartitionRoot$/vault/$dDocType$/$dDocAccount$/$dID$$ExtensionSeparator$$dExtension$

When parsed, the path expression turns into five pieces, interpreted according to the rules specified in the PathMetaData table as follows:

- $PartitionRoot$: mapped to the partitionSelection algorithm and uses the xPartitionId as a lookup into the PartitionList table to determine the partition root.

- /vault/: a string, so no calculation or substitution

- $dDocType$: by the PathMetaData table this is a look up in the file parameters

- $dDocAccount$: this is mapped to a documentAccount algorithm which takes dDocAccount and parses it into the standard Content Server account presentation with all the appropriate delimiters

- $dID$$ExtensionSeparator$$dExtension$: this piece has three parts:

- $dID$: similar to dDocType, this is defined in the file parameters and is a required field

- $ExtensionSeparator$: determined by an algorithm and by default it returns '.'

- $dExtension$: similar to dDocType

In the standard configuration, the URL contains security and dDocType information as well as the dDocName and extension. The URL and the Web location is constructed as follows:

…/groups/$dSecurityGroup$/$dDocAccount$/documents/$dDocType$/$dDocName$.$dWebExtension$

The groups separator indicates to Content Server that the directories that follow are the name of the security group and account to which the content item belongs. Accounts are optional and consequently computed by an algorithm. After the security information, we have the documents separator, which is immediately followed by the dDocType. The last part of the URL is the dDocName and its format extension.

Because the URL is expected in this format, Content Server can successfully extract metadata from it. More importantly, it can determine the security information for the content item and derive the access privileges for a particular user.

The parsing guidelines have been expanded to allow for dispersion in the Web directory. The groups separator is kept, but the documents separator may be replaced with sg. When the parse encounters the sg separator, it no longer assumes that the remaining part of the URL is /sg/$dDocName$.$dWebExtension$. Instead, the parser looks for the dispersion end marker d. When the d is encountered, the system assumes that the following information contains the dDocName and dWebExtension as before. This means that the system can now successfully parse URLs of the form

../groups/$dSecurityGroup$/$dDocAccount$/sg/<dispersion>/<dispersion>…/d/$dDocName$.$dWebExtension$

3.5.3 File Store Provider Resource Tables

This section covers the following topics:

- "PartitionList Table"

- "StorageRules Table"

- "PathMetaData Table"

- "PathConstruction Table"

- "FileSystemFileStoreAlgorithmFilters Table"

- "FileStorage Table"

- "FileCache Table"

3.5.3.1 PartitionList Table

The PartitionList table defines the partitions that are available for the partitionSelection algorithm. The table is defined in the fsconfig.hda file, located in the DomainHome/ucm/cs/data/filestore/config/ directory, and modified using the Add/Edit Partition Page in the Content Server user interface. The columns of the table are used as follows:

Column

Description

PartitionName

Specifies the name of the partition. This name is referenced in the path expression.

PartitionRoot

An argument passed into the partitionSelection algorithm.

IsActive

Determines if the partition is currently active and accepts new files.

CapacityCheckInterval

Specifies the interval in seconds used in determining the available disk space. This may not work on all platforms.

SlackBytes

Determines if there is sufficient space on a partition to store content. If the available space is lower than the slack bytes, the partition is deactivated and no longer used for contribution.

DuplicationMethods

Specifies how native files are treated when not converted to a web-viewable rendition.
copy (default): copies the native file to the Web path.

link: Resolves the Web path to the native file in the vault

Copy and Link rely on functionality of the operating system on which Content Server is installed. As such, not all methods are available on all platforms

3.5.3.2 StorageRules Table

The StorageRules table defines the rules used for storing content items. The rule specifies which path expression to use for which storage class, how content items are to be stored.

The table is defined in the provider.hda file, located in the DomainHome/ucm/cs/data/providers/defaultfilestore/ directory, and modified using the Add/Edit Storage Rule Page in the Content Server user interface. The columns of the table are used as follows:

Column

Description

StorageRule

The name of the storage rule. Computed from a dynamic include and stored in the xStorageRule metadata field of a content item.

StorageType

Determines the storage implementation.
FileStorage: files are stored on the file system

JdbcStorage: files are stored in the database

IsWeblessStore

Used to specify if system allows Web-less files.
true: by default, newly created content items do not have a web-viewable file. In certain circumstances it is necessary to insist on a web-viewable file. In such situations, an argument in the calling code can be used to specify that a web-viewable file must be created. Information regarding whether there is a web-viewable file is stored in the xWebFlag metadata field.

false: by default, newly created content items do have a web-viewable file.

RenditionsOnFileSystem

Used by JdbcStorage to determine if any files are to be stored on the file system instead of the database.

3.5.3.3 PathMetaData Table

The PathMetaData table defines what metadata is used to determine the location of a file. The metadata may come directly from a content item's metadata, or be calculated using an algorithm. The PathMetaData table is defined in the provider.hda file of the defaultfilestore directory. The defaultfilestore directory is located in the DomainHome/ucm/cs/data/providers/ directory.

The columns of the table are used as follows:

Column

Description

FieldName

Name of the field as it appears in the path expression.

GenerationAlgorithm

Specifies the algorithm used to resolve or compute the value for the field.

RequiredForStorage

Defines for which storage class the metadata is required.
#all: Both vault and web-viewable renditions require the metadata

web: Just the web-viewable rendition requires the metadata

vault: Just the native file rendition requires the metadata

The field is optional for all renditions not specified. Consequently, if this column is empty, then the metadata field is optional for all renditions or storage classes. If an algorithm has been specified, this value is empty. The algorithm uses the value specified in the ArgumentFields column to dictate which fields are required.

Arguments

Optional arguments passed into the algorithm specified in the GenerationAlgorithm field.

ArgumentFields

A comma-delimited list of fields required by the arguments defined in the Arguments column, and consequently required by the algorithm specified in the GenerationAlgorithm field.

3.5.3.4 PathConstruction Table

The PathConstruction table maps a file to a path. The PathConstruction table is defined in the provider.hda file of the defaultfilestore directory. The defaultfilestore directory is located in the DomainHome/ucm/cs/data/providers/ directory. For more information, see also "Understanding Path Construction and URL Parsing".

Caution:
The defaults provided in the PathConstruction table should work for most scenarios. This resource file should not be edited directly. Proper modification should be done through additional component development. For more information on component development, see the "Working with Components" chapter in the Oracle Fusion Middleware Developer's Guide for Content Server.

The columns of the PathConstruction table are defined as follows:

Column

Description

FileStore

Specifies the storage path that is being calculated.
web: Path to the web-viewable file.

vault: Path to the native file.

weburl: Generated by Content Server. Tends to be GET_FILE.

weburl.file: Nicely constructed URL used to access the web-viewable rendition in a browser.

PathExpression

Defines the path.

AutoCreateLimit

Specifies the depth of the directories that may be created.

StorageRule

Specifies to which storage rule this path construction belongs.

3.5.3.5 FileSystemFileStoreAlgorithmFilters Table

The FileSystemFileStoreAlgorithmFilters table is used to map an algorithm name to an implementation of the FilterImplementor interface. The algorithm can be referenced in the PathMetaData Table and is used to calculate the desired path field. The class implementing the algorithm must return the required metadata fields it uses for calculation, when the file parameters object is null. Through the ExecutionContext, the doFilter method is passed in information about the field, content item, and file store provider that initiated the call. In particular, for the file system provider, the algorithm will be passed the following information through the ExecutionContext. Bear in mind that other file store providers may choose to pass in more or possibly different information.

Properties fieldProperties = (Properties)
context.getCachedObject("FieldProperties");
Parameters data = (Parameters)
context.getCachedObject("FileParameters");
Map localData = (Map) context.getCachedObject("LocalProperties");
String algorithm = (String) context.getCachedObject("AlgorithmName");

The FileSystemFileStoreAlgorithmFilters table is part of File Store Provider and requires a component along with Java code to modify.

Caution:
The defaults provided in the FileSystemFileStoreAlgorithmFilters table should work for most scenarios. This resource file should not be edited directly. Proper modification should be done with Java code and through additional component development. For more information on component development, see Oracle Fusion Middleware Developer's Guide for Content Server.

3.5.3.6 FileStorage Table

The FileStorage table is added to the Content Server when File Store Provider is installed. It is used exclusively by the JdbcStorage storage type, when content is stored in a database. The FileStorage table contains the renditions of content items and uses the dID of the content item and rendition to uniquely identify what renditions belong to which content item.

3.5.3.7 FileCache Table

The FileCache table is added to the Content Server when File Store Provider is installed. It is used exclusively by the JdbcStorage storage type to remember which renditions have been placed on a file system. Renditions stored in a database are placed on a file system when required for a specific event, for example indexing or conversion. These files are often temporary and deleted after a specified interval as part of a scheduled event.

3.5.4 File Store Provider Sample Implementations

In this section, we explicitly list the contents of the tables contained in the provider definition file (provider.hda) for each of the examples. The provider.hda file does not need to be edited manually. Proper modification of the provider.hda file should be done within the Content Server user interface using the Add/Edit Partition Page, or through additional component development. The provided default options for other resource tables, such as PathMetaData Table, PathConstruction Table, and FileSystemFileStoreAlgorithmFilters Table, should have sufficient flexibility for most scenarios.

This section covers the following topics:

- "Example PathMetaData Table Options"

- "Configuration for Standard File Paths"

- "Configuration for a Webless or Optional Web Store"

- "Configuration for Database Storage"

- "Altered Path Construction and Algorithms"

3.5.4.1 Example PathMetaData Table Options

In most of the examples, the following PathMetaData Table configuration definitions are used. The table has been trimmed of some it columns not pertinent to the examples for clarity.

@ResultSet PathMetaData
6
FieldName
GenerationAlgorithm
RequiredForStorage
<trimmed columns>
dID
#all
dDocName
#all
dDocAccount
documentAccount
dDocType
#all
dExtension
#all
dWebExtension
weburl
dSecurityGroup
#all
dRevisionID
#all
dReleaseState
#all
dStatus
web
xPartitionId
partitionSelection
ExtensionSeparator
extensionSeparator
xWebFlag
RenditionId
#all
RevisionLabel
revisionLabel
RenditionSpecifier
renditionSpecifier
@end

3.5.4.2 Configuration for Standard File Paths

File Store Provider can be configured to place content on a file system in the standard Content Server locations.

3.5.4.2.1 Defining the Storage Rule

The first step is to define the storage rule. In this case, the storage rule will be of type FileStorage, because all content is to be stored on the file system.

Example:

@ResultSet StorageRules
4
StorageRule
StorageType
IsWeblessStore
RenditionsOnFileSystem
default
FileStorage
@end@

3.5.4.2.2 Defining the Path Construction

The second step is to define the path construction for each of the storage classes for the rule. In general, the last part of the path should be standard for all usage examples. If not, then Content Server does not work well with hcs* files. However, the root path can be changed without affecting functionality, assuming that changing the web URL file path root is properly acknowledged by the Web server as a Content Server Web root.

In this configuration, the vault, web and web URL storage classes need to be defined in the PathConstruction Table. The path expression for the vault has already been discussed in \"Understanding Path Construction and URL Parsing". So we will only look at the web path expression, which differs from the Web URL only in its root. In other words, the Web path is an absolute path on the file system, while the web URL is a URL served up by a Web server.

Example:

@ResultSet PathConstruction
4
FileStore
PathExpression
AutoCreateLimit
IsWritable
StorageRule
vault
$#env.VaultDir$$dDocType$/$dDocAccount$/$dID$$ExtensionSeparator$$dExtension$
6
true
default
weburl
$HttpWebRoot$groups/$dSecurityGroup$/$dDocAccount$/documents/$dDocType$/
$dDocName$$RenditionSpecifier$$RevisionLabel$$ExtensionSeparator$
$dWebExtension$
3
false
default
web
$#env.WeblayoutDir$groups/$dSecurityGroup$/$dDocAccount$/documents/
$dDocType$/$dDocName$$RenditionSpecifier$$RevisionLabel$$ExtensionSeparator$$dWebExtension$
3
true
default
@end

- The Web path construction is defined to be:

$#env.WeblayoutDir$groups/$dSecurityGroup$/$dDocAccount$/documents/$dDocType$/
$dDocName$$RenditionSpecifier$$RevisionLabel$$ExtensionSeparator$$dWebExtension$

- This is parsed into its parts and are as follows:

Path Segment

Description

$#env.WeblayoutDir$

Look up in the shared environment for the value 'WeblayoutDir'. This is defined by Content Server to be the physical root path of the weblayout directory.

$HttpWebRoot$

Alternate Idoc Script variable for Web URL

/groups/

String.

$dSecurityGroup$

Used by the PathMetaData table. This is a required field and must consequently be provided by the caller or descriptor creator. It is part of a content item's metadata information.

$dDocAccount$

This is mapped to a documentAccount algorithm which takes dDocAccount and parses it into the standard Content Server account presentation with all the appropriate delimiters.

/documents/

String.

$dDocType$

Used by the PathMetaData table. This is a required field and must consequently be provided by the caller or descriptor creator. It is part of a content item's metadata information.

$dDocName$

Used by the PathMetaData table. This is a required field and must consequently be provided by the caller or descriptor creator. It is part of a content item's metadata information.

$RenditionSpecifier$

This is provided by the renditionSpecifier, which is only of interest if the system is creating additional renditions such as thumbnails. Otherwise, this returns an empty string.

$RevisionLabel$

The revision label is provided by the revisionLabel algorithm which, depending on the status of the content item, adds a '~dRevLabel' to the path.

$ExtensionSeparator$

The extensionSeparator algorithm is used here and by default it returns '.'.

$dWebExtension$

The dWebExtension is a required field for the Web and Web URL storage classes and is passed in through the file parameters.

3.5.4.3 Configuration for a Webless or Optional Web Store

In this example, the previous example storage rule is configured to have IsWeblessStore set to true and consequently the web-viewable file will not be created by default. However, if the document is processed through Inbound Refinery or WebForms or any other component that requires a web-viewable, the web file will be created. The location of the files is as above in the 'standard' configuration. However, since a file may not have a web rendition, the web URL path must be adjusted. Also, note the use of web URL.file. This is used to compute the URL when the web-viewable actually exists. The metadata field xWebFlag is used to determine how the file is to be served up in the browser.

3.5.4.3.1 Defining the Storage Rule

@ResultSet StorageRules
4
StorageRule
StorageType
IsWeblessStore
RenditionsOnFileSystem
default
FileStorage
true
@end@

3.5.4.3.2 Defining the Path Construction

@ResultSet PathConstruction
4
FileStore
PathExpression
AutoCreateLimit
IsWritable
vault
$#env.VaultDir$$dDocType$/$dDocAccount$/$dID$$ExtensionSeparator$$dExtension$
6
true
default
weburl
$HttpCgiPath$?IdcService=GET_FILE&dID=$dID$
&dDocName=$dDocName$&allowInterrupt=1&noSaveAs=1&fileName=$dOriginalName$
3
false
default
weburl.file
$HttpWebRoot$groups/$dSecurityGroup$/$dDocAccount$/documents/$dDocType$/
$dDocName$$RenditionSpecifier$$RevisionLabel$$ExtensionSeparator$
$dWebExtension$
3
false
default
web
$#env.WeblayoutDir$groups/$dSecurityGroup$/$dDocAccount$/documents/
$dDocType$/$dDocName$$RenditionSpecifier$$RevisionLabel$
$ExtensionSeparator$$dWebExtension$
3
true
default
@end

3.5.4.4 Configuration for Database Storage

To store files in the database, we need a storage rule that is of type JdbcStorage. By default, all content items belonging to this rule have their files stored in the database. However, even though the files are stored in the database, there is the presumption of an underlying file system and the system may need to temporarily cache a file on the file system. In particular, this may happen for indexing or for some conversions.

Tech Tip:
A rule can be configured to always store renditions belonging to a given storage class on the file system. This is most useful for systems that store vault files in the database, but web files on the file system.

3.5.4.4.1 Defining the Storage Rule

In the default rule below, all files are stored in the database, while the filesInWeb rule stores the vault files in the database and the web files on the file system.

@ResultSet StorageRules
4
StorageRule
StorageType
IsWeblessStore
RenditionsOnFileSystem
default
JdbcStorage
filesInWeb
JdbcStorage
web
@end@

3.5.4.4.2 Defining the Path Construction

@ResultSet PathConstruction
4
FileStore
PathExpression
AutoCreateLimit
IsWritable
StorageRule
vault
$#env.VaultDir$$dDocType$/$dDocAccount/$dID$$ExtensionSeparator$$dExtension$
6
true
default
weburl.file
$HttpWebRoot$groups/$dSecurityGroup$/$dDocAccount$/documents/$dDocType$/
$dDocName$$RenditionSpecifier$$RevisionLabel$$ExtensionSeparator$
$dWebExtension$
3
false
default
web
$#env.WeblayoutDir$groups/$dSecurityGroup$/$dDocAccount$/documents/
$dDocType$/$dDocName$$RevisionLabel$$RenditionSpecifier$
$ExtensionSeparator$$dWebExtension$
3
true
default
@end

3.5.4.5 Altered Path Construction and Algorithms

The previous examples have kept the file paths consistent with the standard configuration. For very large implementations, this can result in directory saturation and slow performance. The following examples aid in dispersing files over several storage options.

3.5.4.5.1 Using Partitioning

File Store Provider makes it easy to use partitions to create a sparser directory structure. By default, the xPartitionId metadata field is used and becomes a part of a content item revision's metadata information. It is recommended that this field is disabled on the Content Server user interface, instead letting the partition selection algorithm determine the partition to use. The partition selection algorithm looks at all the active partitions, and as a new content enters the system, the partitions are selected in order. Each partition has an entry in the "PartitionList Table" and can be declared active. The PartitionRoot is calculated from the xPartitionId, where the value is a look up key into the PartitionList table. If no xPartitionId is specified, the system finds the next available and active partition and uses this value for the location calculation. The xPartitionId is then stored as part of the content item's metadata.

To use the partition selection, define the vault storage class in the PathConstruction table as follows:

vault
$PartitionRoot$/$dDocType$/$dDocAccount$/$dID$$ExtensionSeparator$$dExtension$
6
true

Partitions can be deactivated using the "Add/Edit Partition Page" at any time if a system administrator needs to close a partition to contribution, for example if maintenance is required on the storage device.

3.5.4.5.2 Limiting the Number Files in a Directory

Another way of dispersing files is to alter the path so that files get partitioned out by the dID of the content item. In the example below, the directories are limited to 10,000 files plus extra files for additional renditions.

If your path expression contains $dID[-12:-10:0]/$dID[-10:-8:0]$/$dID[-8:-4:0]$ and dID is 1234567890, the result is 00/12/3456.

Note the dID[-12:-10:0] in the path expression. This is interpreted as follows:

- Get the characters starting at 12 back from the end of the string until you get the character 10 back from the end of the string.

- Pad the resulting string to length 2, which 12-10, with 0 characters.

3.6 Mapping URLs with WebUrlMapPlugin

Content Server uses Oracle WebLogic Server, which has a built-in Web server, to filter pages through a Web browser. User requests are authenticated in Oracle WebLogic Server and communicated with Content Server.

The WebUrlMapPlugin component enables you to map shortened URLs to other URLs in Content Server using a substitution script for the mapping, which also enables you to map long URLs to abbreviated versions. The WebUrlMapPlugin component is installed (enabled) by default with Content Server.

This section covers these topics:

- "Script Construction"

- "Supported Variables for Referencing"

- "Add/Edit URL Mapping Entries"

- "Mapping Examples"

3.6.1 Script Construction

The shortened URLs that you can create generally use the following format:

http://myhostname.com/prefix/suffix

The actual mapping process is based on the part of the URL that follows the host name portion. To resolve the shortened URL, Content Server compares the prefix to those in the list of defined WebUrlMapPlugin entries. If a match exists, Content Server uses the map script that corresponds to the matching prefix to display the applicable document or Content Server page. For more information about the suffix, see "Supported Variables for Referencing".

To construct a URL mapping entry using the WebUrlMaps Screen, you must establish a prefix and define the corresponding map.

- Prefix
The prefix portion of the mapping entry is any abbreviation you want to use to identify URLs of a certain form. For example, if you want your short URL to return the dynamic conversions of documents, you can use idc as your prefix (for example, the abbreviated form of dynamic converter).

When you create your prefix, do not enter a slash (/) character at the beginning of it because Content Server removes the first slash from the incoming URL before the prefix test is performed.

Caution:
Include a slash (/) at the end of your URL map prefix. Otherwise, your mappings can apply to many more URLs and interfere with standard Content Server operations.

- Map
The map portion of the mapping entry is the Idoc Script code that Content Server uses to resolve the shortened URL. You can use substitution tags (<!--$variable-->) in the map portion. Examples include:

- <!--$cgipath-->

- <!--$internetuser-->

- <!--$suffix-->

These substitution tags are variables that refer to the applicable parameters of a URL.

Simple 'if' constructions are also supported. For example, the following script segment performs a test to determine whether a value exists and is not empty:

<!--$if myconfigvar-->something<!--$endif-->

3.6.2 Supported Variables for Referencing

The map portion of the URL mapping entry uses the following standard variables for referencing:

- The CGI path
This is the current CGI path of the Oracle WebLogic Server Web server filter's configured master Content Server. The Web server filter Oracle WebLogic Server is configured to provide both communication and security for this Content Server. A typical example is /idcm1/idcplg.

- The 'suffix' parameter
The value of the suffix variable (<!--$suffix-->) is derived from the part of the URL that follows the preliminary mapping 'prefix' and before the question mark (?). Any slashes (/) at the beginning of the suffix are removed before being substituted into this variable. For example, in the following URL, 'dc' is the mapping prefix followed by the suffix.

http://myhostname.com/dc/mydocumentname

After removing the slash, mydocumentname is used as the value for the suffix variable that is used as a substitution tag in the map portion of the mapping entry. Also, the suffix variable does not include any CGI parameters. Therefore, in the following URL, mydocumentname is still used as the suffix variable's value.

http://myhostname.com/dc/mydocumentname?a=1

To enforce the slash separation between the prefix and suffix, add the slash at the end of your prefix abbreviation.

- Any plugin variable
For example, you could use the construct <!--$internetuser--> to substitute for the user ID of the currently logged-in user.

- Any CGI parameter

3.6.3 Add/Edit URL Mapping Entries

To add or edit URL mapping entries:

1. Select the Administration tray, then click WebUrlMapPlugin.
The WebUrlMaps Screen is displayed.

2. Enter the appropriate values in the Prefix and Map fields to edit the existing mapping entries, or define new entries, or both.

3. Click Update.
The screen refreshes and the Prefix and Map field values are saved. If all of the displayed fields are populated, two additional Prefix and Map field pairs are displayed after the screen is redisplayed.

Important:
The WebUrlMapPlugin feature is designed to support hundreds of mapping entries. However, be aware that thousands of mapping entries will impact performance of the Web server.

3.6.4 Mapping Examples

The following examples demonstrate mapping scripts and techniques.

- "Info Update Form"

- "Dynamic Conversion"

- "CGI parameters"

3.6.4.1 Info Update Form

You can define a Web URL mapping script that enables you to create a shortened URL to generate the Info Update Form for existing content items. You can write the mapping script to allow users to enter any identification variable for a particular document. For example, all URLs with the following format:

http://myhostname.com/u/mydoc_parameter

can be mapped to the URL:

http://myhostname.com/idcm1//idcplg?IdcService=GET_UPDATE_FORM&dDocName=mydocumentname

To map URLs, define the following Web URL map entry using the WebUrlMaps Screen:

- Prefix:

u/

- Map:

<!--$cgipath-->?IdcService=GET_UPDATE_FORM<!--$suffix-->&myparam=<!--$myparam-->

3.6.4.2 Dynamic Conversion

Dynamic Converter must be installed for this URL mapping example to work.

You can define a Web URL mapping script that enables you to create shortened URLs to various dynamic conversions of documents. For example, all URLs with the following format:

http://myhostname.com/dc/mydocumentname

can be mapped to the URL:

http://myhostname.com/idcm1/idcplg?IdcService=GET_DYNAMIC_CONVERSION&dDocName=mydocumentname&RevisionSelectionMethod=LatestReleased

To map URLs, define the following Web URL map entry using the WebUrlMaps Screen:

- Prefix:

dc/

- Map:

<!--$cgipath-->?IdcService=GET_DYNAMIC_CONVERSION&dDocName=<!--$suffix-->&RevisionSelectionMethod=LatestReleased

3.6.4.3 CGI parameters

You can also directly reference CGI parameters. For example, URLs with the following format:

http://myhostname.com/dcp/mydocumentname?myparam=myvalue

can be mapped to the URL:

http://myhostname.com/idcm1/idcplg?IdcService=GET_DYNAMIC_CONVERSION&dDocName=mydocumentname&RevisionSelectionMethod=LatestReleased&myparam=myvalue

To map URLs, define the following Web URL map entry using the WebUrlMaps Screen:

- Prefix:

dcp/

- Map:

<!--$cgipath-->?IdcService=GET_DYNAMIC_CONVERSION&dDocName=<!--$suffix-->&RevisionSelectionMethod=LatestReleased&myparam=<!--$myparam-->

3.7 Connecting to Outside Entities with Providers

This section covers these topics:

- "About Providers"

- "Content Server Providers"

- "Choosing an Appropriate Provider"

- "Security Providers"

- "Adding an Outgoing Provider"

- "Adding a Database Provider"

- "Adding an Incoming Provider"

- "Adding a Preview Provider"

- "Adding a JPS Provider"

- "Adding an Incoming Security Provider"

- "Adding an Outgoing Security Provider"

- "Editing Provider Information"

- "Deleting a Provider"

3.7.1 About Providers

A provider is an Application Programming Interface (API) that establishes connection to outside entities. These entities can be:

- Oracle WebLogic Server instances

- LDAP servers

- databases

- server sockets

- file store system

- Inbound Refinery

3.7.1.1 Content Server Providers

By default, a Content Server instance has three system providers:

- SystemDatabase: The system database.

- SystemServerSocket: A server socket that listens for browser requests.

- DefaultFileStore: A file store system.

In addition, you can create the following types of providers:

- Outgoing: A connection initiated to an outside entity. You can use this type to communicate between Content Server instances. If you want to use SSL with an outgoing provider, see details in "Security Providers".

- Database: An information repository server that provides an API for connecting and communicating with it. This retrieves information and enables information to be changed in the database. Examples of this type are system databases.

- Incoming: A connection initiated from an outside entity like a browser or client application. The provider listens on a specified port to be aware of incoming connections. If you want to use SSL with an incoming provider, see details in "Security Providers".

- Preview: An outgoing provider connection to Oracle Content Publisher, for use with the optional HTML Preview feature.

- LDAP: A connection initiated to an LDAP (Lightweight Directory Access Protocol) server for managing external user access to the content server. This type of provider is supported by the ActiveDirectoryLdap component, which is installed (disabled) by default during Content Server installation. As of 11g Release 1 (11.1.1) its functionality is mostly superseded by JpsUserProvider, in particular for nested group support.

- HTTP: A connection that allows communication between Content Servers using the HTTP protocol. This type of provider requires the Proxy Credentials Extension component, which is installed (enabled) by default during Content Server installation.

- JpsUserProvider: A connection to an Oracle WebLogic Server instance. This provider uses Java Platform Security (JPS) to perform user authentication, user authorization, and retrieval of user metadata through an Oracle WebLogic Server. This type of provider is supported by the JpsUserProvider component, which is installed (enabled) by default with Content Server.

3.7.1.2 Choosing an Appropriate Provider

The different types of providers described in the previous section are added under specific circumstances to work with various other Oracle products or utilities. The following subsections describe those conditions and the particular provider types that must be added in each scenario.

- "When to Add an Outgoing Provider"

- "When to Add a Database Provider"

- "When to Add an Incoming Provider"

- "When to Add a Preview Provider"

- "When to Add an LDAP Provider"

- "When to Add a JPS User Provider"

3.7.1.2.1 When to Add an Outgoing Provider

Outgoing providers are added to use the Content Server Archiver utility and Inbound Refinery. If you want to use SSL or keepalive with an outgoing provider, see details in "Security Providers".

- Archiver Utility (Content Server): The Archiver is a utility within the core Content Server product that enables system administrators to copy and remove content and store it for future use. Users can query a set of content from the Content Server instance and export it to an archive. Archives can then be imported to other Content Server instances or can be imported back to the same instance with changed metadata fields.
An outgoing provider is required to use the Archiver Transfer feature, which is used to archive content across a firewall or between two systems that do not share a file system. For additional information about the Transfer feature, the different types of transfers and the outgoing provider requirements, see the Managing Migration chapter for more information.

For additional reference information about outgoing providers and each specific field, see "Outgoing Provider Page".

- Inbound Refinery: The Inbound Refinery server processes content checked in to Content Server and converts it to specified formats. An outgoing connection to the Inbound Refinery server is necessary for communication with Content Server. For details, see Oracle Fusion Middleware Administrator's Guide for Conversion.

3.7.1.2.2 When to Add a Database Provider

Database providers are added to use external databases.

Frequently, it is desirable or necessary to perform database queries on databases that are not the default Content Server database. In this case, customized database providers can be created that make it possible to access any data from any application, regardless of which database management system is handling the data. Using customized database providers to integrate external databases into a Content Server system, search results can be combined and viewed on a single search screen. Additionally, data can be imported from these external database sources.

Administrators can create a database provider in one of two methods:

- Use the Oracle WebLogic Server Administration Console to create an Oracle WebLogic Server data source to the database, then configure a Content Server database provider to use that data source. For information, see "Creating a JDBC Data Source for a WebLogic Domain Server" in Oracle Fusion Middleware Developer's Guide for Oracle Application Development Framework.

- Create a Content Server database provider to connect directly to the database through a JDBC connection, without using an Oracle WebLogic Server data source. This mode is provided for instances with pre-existing connections in their configurations.

For additional reference information about Content Server database providers and each specific field, see "Database Provider Page".

Consulting Services is required to perform this operation.

3.7.1.2.3 When to Add an Incoming Provider

Incoming providers are added to use WebDAV support and the Content Server Archiver utility. If you want to use SSL or keepalive with an incoming provider, see details in "Security Providers".

- Oracle WebDAV Support: With version 6.2 of Content Server, you could implement WebDAV (Web-Based Distributed Authoring and Versioning) support using an incoming provider and the Content Server integrated Tomcat servlet engine. In Content Server version 7.0 and later, however, WebDAV support is provided by a custom feature, so the provider and servlet engine are no longer necessary.
See the Oracle Fusion Middleware Applications Administrator's Guide for Content Server for more information.

- Archiver Utility (Content Server): The Archiver is a utility within the core Content Server product that enables system administrators to copy and remove content and store it for future use. Users can query a set of content from the Content Server instance and export, import, or replicate to another instance, or change metadata fields. Tasks most frequently performed involve transfer, backup, and reorganization of information within the system.
Generally, when data or content items are moved from one repository to another, the Archiver utility uses a push technology to relocate the files. However, occasionally your system might require that the files be pulled rather than pushed. In this case, an incoming provider must be created. For additional reference information about incoming providers and each specific field, see "Incoming Provider Page".

Consulting Services are required perform this operation.

3.7.1.2.4 When to Add a Preview Provider

Preview providers are added to use HTML Preview and Content Categorizer.

- HTML Preview: HTML Preview is a feature that provides users with instant feedback on how their content will display on the published Web site. This feature enables users to modify the original content before it is actually checked in. HTML Preview also helps users ensure that correct metadata has been assigned to the content. During the installation process, a preview provider must be created. For additional overview and installation information about HTML Preview, see the Oracle Fusion Middleware Application Administrator's Guide for Content Server.

- Content Categorizer: Content Categorizer suggests metadata values for documents being checked into Content Server or for existing documents that need to have metadata reapplied. For Content Categorizer to recognize structural properties of a document, the file must be converted to XML.
If you are using Content Publisher to set up a template for the required XML conversion process, the HTML Preview feature must be configured as a preview provider. (HTML Preview is a feature that enables users to preview their content and see what the converted output from Content Publisher will look like.)

For more general overview, reference, pre-installation tasks and considerations, and complete installation information about Content Categorizer, see the Oracle Fusion Middleware Administrator's Guide for Content Categorizer. This guide provides relevant information about any additional products that may be required or are optional. For additional reference information about preview providers and each specific field, see "Preview Provider Page".

3.7.1.2.5 When to Add an LDAP Provider

Lightweight Directory Access Protocol (LDAP) is a directory service protocol that runs over TCP/IP. It provides high-level functionality to manage resources within a network and works with Content Server to manage security and user authentication. The LDAP directory service model is based on a collection of attributes and is used to access information stored in an information directory. As such, LDAP is used to validate a set of user name and password credentials against an authentication source. This process will grant privileges to a user to give them access to Web resources.

An LDAP server provides a single source for user-related information that can be accessed from applications such as Content Server and other Oracle product modules. Instead of maintaining user information within Content Server, you can integrate an LDAP directory to authenticate user credentials to the Content Server instance.

Note:
As of 11g Release 1 (11.1.1), LDAP provider functionality is superseded by JpsUserProvider. Use of the LDAP provider is not recommended. See "When to Add a JPS User Provider".

If you decide to use an LDAP server (other than Active Directory, which can be integrated directly with the Content Server), you must create an LDAP provider to set up communication between the Content Server instance and the LDAP server. When properly configured, the LDAP provider authorizes external users through the mapping properties that are linked to role assignments and account permissions (defined on the Ldap Provider page).

For additional reference information about LDAP providers and each specific field, see "LDAP Provider Page".

Although not required, you are encouraged to have Consulting Services assist you with creating an LDAP security model and deploying the LDAP integration. Contact your sales representative for more information.

LDAP integration is also useful with the following content management products and architectures:

- Portlets on WebSphere: WebSphere users can access Content Server through the Oracle Content Integration Suite. This portal interface enables users and developers to retrieve, view, and download Content Server content items based on full text or metadata search queries. When using the Content Integration Suite, the WebSphere Application Server is recommended. If you are using a WebSphere Portal Server, the Oracle Content Portal Suite is a recommended addition to the Content Integration Suite.
The Content Integration Suite connects directly to the Content Server instead of the database. This direct connection avoids the authentication step at the Web server and enables the developer total control over the authentication and authorization of users. The advantage is you can authenticate users at the Content Integration Suite layer however you want. You can integrate with an LDAP server at the application server level, or you can ask the Content Server to validate the passwords for you.

For more information about using WebSphere with the Content Integration Suite and the Content Portal Suite, see the documentation provided with the WebSphere Portal Server, WebSphere Application Server, Oracle Content Integration Suite, and Oracle Content Portal Suite.

- Content Tracker: Content Tracker is a system that is built from a collection of software features that, when combined, enable users to use a standard browser to track content usage through an integrated set of analytical tools. The data provided by the Content Server is derived from logged data that includes Web server log data, Content Server data, and user information. Content Tracker accesses this data, performs analysis on it, and produces descriptive reports. Integrating an LDAP directory server with Content Tracker is optional. However, if LDAP is used, an LDAP provider must be created.
For more information about the related data repositories, report generation, producing queries and installation procedures, see the Oracle Fusion Middleware Application Administrator's Guide for Content Server.

3.7.1.2.6 When to Add a JPS User Provider

JpsUserProvider connects to an Oracle WebLogic Server instance and supports the Oracle WebLogic Server authentication mechanism (Basic, Form, Single Sign On, WNA, and so forth). Java Platform Security (JPS) provides a uniform interface for authenticating and authorizing users from Oracle Fusion Middleware applications regardless of the back-end user storage (XML, LDAP, database, Active Directory, and so on). JPS API calls are used to perform user authentication, user authorization and retrieval of user metadata.

Note:
As of 11g Release 1 (11.1.1), LDAP provider functionality is superseded by JpsUserProvider, in particular for cases such as nested group support.

JpsUserProvider is installed and enabled with Content Server as a system component when Content Server is installed against an Oracle WebLogic Server instance. It also is available as a standard Content Server component. You can configure JpsUserProvider from the Providers page in Content Server. The connection also can be configured through the jps-config.xml file to use identity and credential stores.

If you want to authenticate against a JPS store, JpsUserProvider can be used to share the same security storage as another application with Oracle WebLogic Server. For example, you could use JpsUserProvider to share security storage with Image and Processing Manager software installed on an Oracle WebLogic server.

3.7.1.3 Security Providers

This section covers the following topics:

- "About Security Providers"

- "Planning to Use Security Providers"

- "When to Use Keystores and Truststore"

3.7.1.3.1 About Security Providers

The Security Providers component can be used to add security by extending the functionality of basic incoming and outgoing socket providers with two new types of providers:

- Secure Socket Layer (SSL) provider

- Keepalive provider

Appropriate use of security providers, along with keys and certificates, can improve the security for network and Internet communication with Content Server. Benefits of using the Security Providers component include the following:

- SSL enhances security for Web communication by providing communication encryption and authentication.

- Security providers enable use of certificates for socket or server authentication.

- Keepalive and connection pooling logic help avoid SSL expense overhead by reducing the amount of SSL socket creation and teardown.

The Security Providers component is installed (enabled) by default with Content Server.

References

To use the Security Providers component it is necessary to be familiar with socket providers, security and authentication, SSL, keepalive, and other aspects of security for network communication. The following sources of information can be useful in working with the Security Providers component:

- "Connecting to Outside Entities with Providers"

- Sun Java Secure Socket Extension (JSSE) Reference Guide for the Java 2 SDK, Standard Edition
This online document is available from Sun Microsystems at www.sun.com. It contains an extensive Related Documents section that includes Web links to reference books, security standards, government security policies and regulations, and a list of books on cryptography and SSL.

- keytool Key and Certification Management Tool
This online document is available from Sun Microsystems at www.sun.com.

- RSA's Public Key Cryptography Standards
This online document is available from RSA at www.rsasecurity.com.

- RSA's Cryptography FAQ
This online document is available from RSA at www.rsasecurity.com.

- SSL Certificate FAQ
This online document is available from The Linux Documentation Project at www.tldp.org.

Terminology

The following table shows definitions for some of the security terms used in this section. For detailed information refer to the list of information references or to security and authentication standards sources.

Term

Description

Certificate

A digital signature that verifies the identity and public key for an entity (a person or company). A certificate can be issued by a Certification Authority or by an individual entity.

Certificate Authority (CA)

An entity that issues certificates for other entities, and is recognized as a well-known and trusted source for certificates, such as VeriSign and Thawte.

Keystore

A file or database of information for keys, used for authentication processing.

Private key

Information packaged as a key that is known only to the entity that issues it. Private keys are used in generating signatures.

Public key

Information packaged as a key that is publicly associated with an entity. Public keys are used in verifying signatures.

SSL

Secure Socket Layer, a protocol for secure network communication using a combination of public and secret key technology.

Truststore

A file or database of keys that the trust manager has determined can be trusted.

3.7.1.3.2 Planning to Use Security Providers

It is recommended that you determine how you want to use security providers before implementing SSL socket providers or keepalive socket providers. Examine the keepalive and SSL connection types and determine whether additional configuration is required to use the security providers you select, such as a need to create keystores or a truststore. Refer to the additional sources of information listed in "About Security Providers".

The following sections provide more information about the SSL and keepalive provider types, including the Java classes used to control the behavior of the provider types, and additional configuration that may be necessary.

- "Keepalive Connections"

- "SSL Connections"

- "Additional Configuration"

Keepalive Connections

The keepalive feature enables persistent connections and the pooling of socket connections for service requests. The setup for keepalive connections is most useful in situations where connection setup and teardown can take a considerable amount of time, and you want to minimize the time spent on that activity. The Security Providers component provides two keepalive socket providers: incoming and outgoing.

The following Java classes are used to set up the keepalive incoming socket provider:

Java Class

Description

Provider Class

idc.provider.ExtendedSocketIncomingProvider

Connection Class

idc.provider.KeepaliveSocketIncomingConnection

Server Thread Class

idc.server.KeepaliveIdcServerThread

The following Java classes are used to set up the keepalive outgoing socket provider:

Java Class

Description

Provider Class

idc.provider.KeepaliveSocketOutgomingProvider

Connection Class

idc.provider.KeepaliveSocketOutgomingConnection

Request Class

idc.server.KeepaliveServerRequest

SSL Connections

The SSL provider setup enables the use of SSL connections in a keepalive environment. This setup is recommended over a simple SSL provider setup because it helps minimize the cost of SSL socket setup and teardown. The Security Providers component provides two SSL socket providers with keepalive: incoming and outgoing.

The following Java classes are used to set up the SSL keepalive incoming socket provider:

Java Class

Description

Provider Class

idc.provider.ssl.SSLSocketIncomingProvider

Connection Class

idc.provider.KeepaliveSocketIncomingConnection

Server Thread Class

idc.server.KeepaliveIdcServerThread

The following Java classes are used to set up the keepalive SSL outgoing socket provider:

Java Class

Description

Provider Class

idc.provider.KeepaliveSocketOutgoingProvider

Connection Class

idc.provider.ssl.SSLSocketOutgoingConnection

Request Class

idc.provider.KeepaliveServerRequest

Additional Configuration

Depending on which type of security provider you choose, there can be additional required configuration.

- Keepalive and SSL outgoing providers—The Add Provider page includes a Num Connections field, which specifies the number of connections to pool.

- SSL incoming providers—The Add Provider page includes two additional options:

- Request Client Auth option—If clients are able, they should authenticate themselves when they make a connection.

- Require Client Auth option—Clients must authenticate themselves in order to make a connection.

SSL providers may also require setup of a keystore or keystores, and a truststore, for both the client and server, depending on the value of the Request Client Auth option, the value of the Require Client Auth option, and what type of Certification Authority signed the certificates handled by these options. For information on keystores and truststore refer to "Keystores and Truststore".

3.7.1.3.3 Keystores and Truststore

SSL providers may require use of keystores and may require a truststore. Keystores are files that hold public and secret key information for use in SSL. A truststore contains certificates that have been determined to be trusted. If a certificate used on the server and client is signed by a well-known Certification Authority (CA) such as VeriSign or Thawte, then a truststore is not necessary, because the default JVM truststore contains the certificates of these CAs. Truststores are needed when certificates used by the SSL providers are self-signed or signed by a private CA. If SSL providers require keystores, and a truststore, then they must be created and managed.

The following sections provide overview information about keystores and truststore.

- "When to Use Keystores and Truststore"

- "Specifying Keystore and Truststore Information"

- "Generating a Keystore"

- "Creating a Truststore"

For detailed information on keystores and truststores refer to the sources of information listed in "About Security Providers".

When to Use Keystores and Truststore

The following examples present different situations and uses for keystores and a truststore.

- The server requires a keystore containing a signed SSL certificate in order to create SSL sockets.

- The server requests or requires client authentication, which may require a truststore. If the client's certificate is not signed by a well-known CA, then the server will need a truststore containing that CA's certificate.

- The server requests or requires client authentication, which may require that the client have a keystore in which it stores the certificate the client presents for authentication.

- The server uses a certificate that hasn't been signed by a well-known CA, therefore the client will require a truststore that contains the server's certificate.

Specifying Keystore and Truststore Information

In order to use keystore and truststore information, the SSL incoming and outgoing providers require that a file named sslconfig.hda be set up in the providers directory (next to the provider.hda file). The sslconfig.hda file contains configuration information you specify for your keystore and truststore. It has a format similar to the following example. For security reasons, there is no Web interface to assist in editing this file; all edits must be done manually using a text editor. Make certain no trailing spaces are included at the end of each line of this or any .hda file.

@Properties LocalDataTruststoreFile=/servers/idc/data/providers/ssloutgoing1/truststoreKeystoreFile=/servers/idc/data/providers/ssloutgoing1/keystore@end

Configuration Name

Value Description

TruststoreFile

The full path to the truststore file.

KeystoreFile

The full path to the keystore file.

Generating a Keystore

This section describes the basic process for generating a keystore. You must determine the specific requirements and names for keys and keystores you want to create for your SSL providers. You can store keystore files wherever you want, because the sslconfig.hda file contains full paths for its KeystoreFile config settings. However, it is recommended that keystore files are stored in the IntradocDir/data/providers/provider_name directory (next to the provider.hda and sslconfig.hda files) or in the IntradocDir/config/ directory. Aliases and passwords are set using the provider page in Content Server.

For detailed information on how to use the keytool utility to generate a keystore, see the document titled keytool Key and Certification Management Tool, available online from Sun at www.sun.com.

Note:
The Java keytool utility has a feature that prevent direct interaction with private keys. This feature means that a certificate that is generated using keytool is "stuck" in the keystore; there is no way to retrieve the private key portion of the certificate. Inversely, there is no way for keytool to import a pre-existing certificate into a Java keystore.
The Portecle Java keystore allows the import and export of private keys from Java keystores. For information refer to portecle.sourceforge.net.

To use keytool you must have the utility in your path when you enter the command.

1. Create a key in a keystore. The following command-line example shows how to create a key entry with the name alias in a keystore with the name keystore. This command prompts for a keystore password, for information that will be used to generate the key, and for a password for the key itself. If the password on the key is different from the password on the keystore, then the values KeystoreAlias and KeystoreAliasPassword are required to retrieve the key.

keytool -genkey -v -alias alias -keystore keystore

2. Generate a certificate signing request.The following command-line example shows how to generate a certificate signing request for the key entry named alias in the keystore named keystore, which is then stored in the file named csr_file. This file can be sent to a CA to be signed.

keytool -certreq -v -alias alias -keystore keystore -file csr_file

3. Import the CA's certificate into the keystore. The keytool checks the chain of trust on the user's certificate upon import. If the certificate was signed by a CA that is not well-known and the keytool knows nothing about the CA, the certificate is rejected. Therefore any certificate from a CA that is not well-known must first be imported into the keystore to permit the user's certificate to successfully be imported in the next step. The following command line example shows how to import a certificate in a file named cert_file into the keystore named keystore:

keytool -import -v -alias ca_alias -keystore keystore -file cert_file

4. Import the signed certificate back into the keystore. Once the certificate signing request has been received by a CA and the signed certificate is sent back from the CA, the certificate can be read into the keystore entry identified by alias.The following command line example shows how to import the signed certificate.

keytool -import -v -alias alias -keystore keystore_name -file csr_file

5. Check that everything is in the keystore.

keytool -list -v -keystore keystore_name

Creating a Truststore

This section describes the basic process for generating a truststore. A truststore is necessary when an SSL provider uses keys that have not been signed by a well-known Certification Authority. A truststore contains only public certificates that have been verified by the person managing the truststore (the trust manager) for the Content Server. You must determine the specific requirements and name for the truststore you want to create. You can store a truststore file wherever you want, because the sslconfig.hda file contains a full path for a TruststoreFile config setting. However, it is recommended that a truststore file is stored in the IntradocDir/data/providers/provider_name directory (next to the provider.hda and sslconfig.hda files) or in the IntradocDir/config/ directory.

For detailed information on how to use the keytool utility to generate a truststore refer to the document titled keytool Key and Certification Management Tool, available online from Sun at www.sun.com.

To use keytool you must have the utility in your path when you enter the command.

The following command line example shows how to create a truststore:

keytool -import -v -alias alias -keystore keystore -file cert_files

Variable

Description

alias

Alias name for the key.

keystore

Name of the keystore.

cert_file

Path to the Certification Authority's certificate.

3.7.2 Managing Providers

The following tasks are involved in managing providers.

- Adding an Outgoing Provider

- Adding a Database Provider

- Adding an Incoming Provider

- Adding a Preview Provider

- Adding a JPS Provider

- Adding an Incoming Security Provider

- Adding an Outgoing Security Provider

- Editing Provider Information

- Deleting a Provider

3.7.2.1 Adding an Outgoing Provider

To create an outgoing provider:

1. Display the Providers Page.

2. In the Create a New Provider table, click Add in the Action column for the outgoing provider type.
The Outgoing Provider Page is displayed.

3. Complete the following fields:
Required fields

- Provider Name

- Provider Description

- Server Host Name

- Server Port

- Provider Class (predefined)

Optional fields

- Connection Class (predefined)

- Configuration Class

- Relative Web Root

- HTTP Server Address

- Instance Name

- Proxied (check box)

- Notify Target (check box)

- Users (check box)

- Released Documents (check box)

- Required Roles

- Account Filter

4. Click Add.
The Providers page is displayed, with the new provider added to the Providers table.

5. Restart the content server.

3.7.2.2 Adding a Database Provider

It is recommend that you use Consulting Services to connect to other databases using a provider. Contact your sales representative for more information.

3.7.2.3 Adding an Incoming Provider

Consulting Services are required to use providers to connect to server sockets.

To add an incoming provider:

1. Display the Providers Page.

2. In the Create a New Provider section, click Add in the Action column for the incoming provider type.
The Incoming Provider Page is displayed.

3. Complete the following fields:
Required fields

- Provider Name

- Provider Description

- Server Port

- Provider Class (predefined)

Optional fields

- Connection Class (predefined)

- Configuration Class

4. Click Add.
The Providers page is displayed, with the new provider added to the Providers table.

5. Restart the content server.

3.7.2.4 Adding a Preview Provider

See the Oracle Fusion Middleware Application Administrator's Guide for Content Server for instructions on adding the Preview provider. The HTML Preview feature zip file and guide are available for download from the Oracle Technology Network Web site.

3.7.2.5 Adding a JPS Provider

To add a user provider which integrates with Oracle JPS (for Oracle WebLogic Server), follow these steps:

1. Display the Providers Page.

2. In the Create a New Provider table, click Add in the Action column for the ldapuser provider type.
The JPS User Provider Page is displayed.

3. Complete the following fields:
Required fields

- Provider Name

- Provider Description

- Provider Class

- Source Path

Optional fields

- Connection Class

- Configuration Class

- JPS Context

- Default Network Roles

4. To specify an attribute map:

1. Select an information field from the JPS Attributes list.

2. Select a Content Server user information field from the User Attribute list.

3. Click Add.
The attribute map is added to the text box.

4. If necessary, edit the attributes directly in the Attribute Map text box.

5. If necessary, change or add Default Network Roles.

6. Click Add.
The Providers page is displayed, with the new provider added to the Providers table.

7. Restart the content server.

8. Restart the Web server.

3.7.2.6 Adding an Incoming Security Provider

To add an incoming security provider, follow these steps:

1. Display the Providers Page.

2. In the Create a New provider table, click Add in the Action column for the keepaliveincoming or the sslincoming provider type. The keepaliveincoming Provider Page or the sslincoming Provider Page is displayed.

3. Complete the following fields:
Required Fields

- Provider Name

- Provider Description

- Provider Class (predefined)

- Server Port

Optional Fields

- Connection Class (predefined)

- Configuration Class

- Server Thread Class (predefined)

Optional check boxes (sslincoming provider only)

- Request Client Authentication

- Require Client Authentication

4. Click Add. The Providers Page is displayed with the new provider added to the Providers table.

5. Restart the content server.

3.7.2.7 Adding an Outgoing Security Provider

To add an outgoing security provider, follow these steps:

1. Display the Providers Page.

2. In the Create a New provider table, click Add in the Action column for the keepaliveoutgoing or ssloutgoing provider type. The keepaliveoutgoing Provider Page or the ssloutgoing Provider Page is displayed.

3. Complete the following fields:
Required Fields

- Provider Name

- Provider Description

- Provider Class (predefined)

- Server Host Name (predefined)

- Server Port

- Instance Name

- Relative Web Root

Optional Fields

- Connection Class (predefined)

- Configuration Class

- Request Class (predefined)

- Number of Connections (predefined)

- HTTP Server Address

- Proxied (check box)

- Notify Target (check box)

- Users (check box)

- Released Documents (check box)

- Required Roles

- Account Filter

4. Click Add. The Providers Page is displayed, with the new provider added to the Providers table.

5. Restart the content server.

3.7.2.8 Editing Provider Information

To edit information for an existing provider (except for default system providers):

1. Display the Providers Page.

2. In the Providers table, click Info in the Action column for the provider to edit.
The Provider Information Page is displayed.

3. Click Edit.
The Add/Edit Provider Page is displayed.

4. Make the required changes.

5. Click Update to save the changes and return to the Providers page.

6. Restart the content server.

3.7.2.9 Deleting a Provider

To delete an existing provider (except for default system providers):

1. Display the Providers Page.

2. In the Providers table, click the Info link in the Action column for the provider you want to delete.
The Provider Information Page is displayed.

3. Click Delete.
A confirmation screen is displayed.

4. Click OK.
The provider is removed from the Providers table.

Important:
Ensure that you intend to delete the provider and not just edit the information. When you delete a provider, the provider name and all of its related information is permanently removed from the Providers table.

3.8 Managing Scheduled Jobs

The Scheduled Jobs feature for Content Server enables jobs to be run as part of the scheduled system events. You can perform the following activities using the Scheduled Jobs interface:

- Register jobs to either the long or short queue.

- Promote or demote jobs in queue.

- Cancel jobs.

- Remove a job permanently from a queue.

- Use exception handling; that is, a job that creates another job, and so forth.

- Submit jobs for immediate work.

- Execute a job repeatedly, or only once with a designated start time.

- Execute any service type call.

For details on the interface, see .

3.9 Batchloading Content

This section covers these topics:

- "About Batch Loading"

- "Preparing a Batch Load File"

- "Running the Batch Loader"

- "Optimizing Batch Loader Performance"

3.9.1 About Batch Loading

This section describes how to use the Batch Loader utility to check in (insert), delete, or update a large number of files on your Content Server system simultaneously. The Batch Loader can save you time and effort by automating the batch loading process. The following are examples of when to use the Batch Loader:

- You just purchased the Content Server software, and you want check in all of your existing files with metadata that exists in a database.

- You have documents checked into the Content Server repository, and you just created a new custom metadata field. You can use the Batch Loader to add the values you specify for the new metadata field to each existing content item.

- You want to remove a large number of specific files from the system.

Note:
For the Batch Loader utility to function correctly with Oracle WebLogic Server, you must have JDBC connection settings configured. See "Configuring System Database Provider for Standalone Mode".

The Batch Loader performs actions that are specified in a batch load file, which is a text file that describes the action to perform and the metadata for each content item in the batch.

A batch load file is a text file that tells the Batch Loader which actions to perform and what metadata to assign to each content item in the batch.

This section covers these topics:

- "File Records"

- "Actions"

- "Insert"

- "Delete"

- "Update"

- "Optional Parameters"

- "Custom Metadata Fields"

3.9.1.1 File Records

A batch load file is made up of file records, which are sets of name/value pairs that specify the action to perform, or the metadata for individual content items, or both.

Important:
Field names and parameters are case sensitive. They must appear in the batch load file exactly as they appear in the following sections. For example, dDocName is not the same as ddocname, dDocname, or DDOCNAME.

- Each file record ends with an <<EOD>> (end of data) marker.

- A pound sign (#) followed by a space at the beginning of a line indicates a comment. The comment character must be followed by a space. For example: # primaryFile=test.txt works properly, but #primaryFile=test.txt will cause errors.

- The following is an example of a file record:

# This is a comment
Action=insert
dDocName=Sample1
dDocType=Document
dDocTitle=Batch Load record insert example
dDocAuthor=sysadmin
dSecurityGroup=Public
primaryFile=links.doc
dInDate=8/15/2001
<<EOD>>

3.9.1.2 Actions

Valid actions for batch loading are Insert, Delete, and Update.

- If no action is specified for a file, the system tries to perform an update.

- Each file record can have only one action, but file records with different actions can be present in the same batch load file.

- The logic process for each action is different.

3.9.1.3 Insert

The insert action checks a new file into the content server repository. If the Content ID (dDocName) already exists in the content server, no action is performed.Figure 3-11 illustrates the insert action.

Figure 3-11 The Insert Action Sequence for Checking In a New File

3.9.1.3.1 Insert Requirements

The following table defines the fields required for successful performance of an insert action.

Note:
Batch loaded revisions will not enter a workflow even if they meet the criteria for an active workflow.

- Field Length: Maximum number of characters permitted in the field.

- Carried Over: If the next record does not contain this field, the value of this field will be taken from the previous record.

Important:
If you have defined any custom metadata fields as required fields, those fields also need to be defined for an insert action.

Required Items

Field Length

Carried Over

Definition

Action=insert

N/A

Yes

The command to insert a file.
The term Action is case sensitive and must be initial capitalized.

dDocName

30

No

The metadata field named Content ID.

dDocType

30

Yes

The metadata field named Type.

dDocTitle

80

No

The metadata field named Title.

dDocAuthor

30

Yes

The metadata field named Author.

dSecurityGroup

30

Yes

The metadata field named Security Group.

primaryFile

N/A

N/A

The metadata field named Primary File. The Primary File name can be a complete path or just the file name. If a file name only is specified, the location of the file is determined as follows:

- If the SetFileDir optional parameter has been set in this file record or any previous file record, the directory specified in SetFileDir will be used.

- If the SetFileDir parameter has not been set, the batch load file path is used. (The path is specified in the Batch Load File field on the Batch Loader Application.)

dInDate

N/A

No

The metadata field named Release Date.

- The dInDate must use the date format of the locale of the user executing the Batch Loader. For example, the US English date format is mm/dd/yy hh:mm:ss am/pm.

- Time information is optional. If you specify the time, only the hh:mm part is required. The ss and am/pm parts are optional.

<<EOD>>

N/A

N/A

Indicates the end of data for the file record.

3.9.1.3.2 Insert Example

The following code fragments show the batch load file syntax for inserting files. This example shows two file records.

The first file record includes all required fields and the action statement, Action=insert. The second file record does not list the required fields dDocType, dDocAuthor, or dSecurityGroup. However, the information for these items is taken from the previous record. Also, the second record does not specify an action, so the insert action is carried over. Therefore, if the Content ID HR003 does not exist, the file will be inserted. However, if the Content ID does exist, it will not be inserted because the action is insert and not update.

- First record:

Action=insert
dDocName=HR001
dDocType=Form
dDocTitle=New Employee Information Form
dDocAuthor=Olson
dSecurityGroup=Public
primaryFile=hr001.doc
dIndate=3/15/97
<<EOD>>

- Second record:

dDocName=HR003
dDocTitle=Performance Review
primaryFile=hr003.doc
dIndate=3/15/97
<<EOD>>

3.9.1.4 Delete

The delete action deletes one or all revisions of an existing file from the content server repository. If the specified Content ID (dDocName) does not exist in the content server, no action is performed. Figure 3-12 illustrates the delete action.

Figure 3-12 The Delete Action Sequence

3.9.1.4.1 Delete Requirements

The following table defines the fields required for successful performance of a delete action.

Required Items

Definition

Action=delete

The command to delete a file.
The term Action is case sensitive and must be initial capitalized.

dDocName

The metadata field named Content ID.

<<EOD>>

Indicates the end of data for the file record.

3.9.1.4.2 Delete Example

The following example shows the batch load file syntax for deleting files. This example shows two file records. The first file record will delete all revisions of the Content ID HR001. The second file record will delete revision 2 of the content item HR002.

Action=delete
dDocName=HR001
<<EOD>>
Action=delete
dDocName=HR002
dRevLabel=2
<<EOD>>

3.9.1.5 Update

The update action updates existing content items. One of the following actions occurs, depending on what items are present in the file record and what content exists in the system:

- A new revision of an existing content item is created.

- An existing file's metadata is updated.

- A new content item is inserted (Action=insert is performed).

Note:
Batch loaded revisions will not enter a workflow even if they meet the criteria for an active workflow.

A new revision is created when one of the following scenarios occur:

Scenario

Content ID (dDocName)

Revision (dRevLabel)

Release Date in Batch Load file (dInDate)

Scenario 1

Exists in Content Server

Not specified in the batch load file.

After the release date of the latest revision of the file in the system.

Scenario 2

Exists in Content Server

Specified in the batch load file, but does not exist in the Content Server.

After the release date of the latest revision of the file in the system.

Figure 3-13 The Update Action Sequence

3.9.1.5.1 Update Requirements

The following table defines the fields required for successful performance of an update action.

Required Items

Field Length

Carried Over

Definition

Action=update

N/A

Yes

The command to update a file.
The term Action is case sensitive and must be initial capitalized.

dDocName

30

No

The metadata field named Content ID.

dDocType

30

Yes

The metadata field named Type.

dDocTitle

80

No

The metadata field named Title.

dDocAuthor

30

Yes

The metadata field named Author.

dSecurityGroup

30

Yes

The metadata field named Security Group.

primaryFile

N/A

N/A

The metadata field named Primary File.
If only the metadata is being updated, the primaryFile field is not required but dRevLabel is required.

If the optional dRevLabel field is specified and matches a revision label that exists in the content server, the primaryFile field is not required; the primary file specified for that revision is used.

It is important to note that although dRevLabel is not a required field, if the primaryFile is not present, then dRevLabel becomes a required field.

The Primary File name can be a complete path or just the file name. If a file name only is specified, the location of the file is determined as follows:

- If the SetFileDir optional parameter has been set in this file record or any previous file record, the directory specified in SetFileDir will be used.

- If the SetFileDir parameter has not been set, the batch load file path is used. (The path is specified in the Batch Load File field on the Batch Loader Application.)

dInDate

N/A

No

The metadata field named Release Date.

- The dInDate must use the date format of the locale of the user executing the Batch Loader. For example, the US English date format is mm/dd/yy hh:mm:ss am/pm.

- Time information is optional. If you specify the time, only the hh:mm part is required. The ss and am/pm parts are optional.

<<EOD>>

N/A

N/A

Indicates the end of data for the file record.

3.9.1.5.2 Update Example 1

This example assumes that two files are already checked into the system with the following metadata:

- HR001 has a Release Date of 9/26/98 and Revision of 1

- HR002 has a Release Date of 3/15/99 and Revision of 2

The first file record, Content ID HR001, exists in the system, but it does not have a Revision (dRevLabel) specified in the batch load file. Therefore, the Batch Loader will compare the Release Date of the latest revision in the system with the Release Date specified in the batch load file. Since 2/20/99 is after 9/26/98, a new revision 2 for HR001 is added.

The second file record, Content ID HR002, exists in the system and has a Revision (dRevLabel) specified, but Revision 3 does not exist in the system. Therefore, a new revision 3 for HR002 is added.

Action=update
dDocName=HR001
dDocType=Form
dDocTitle=New Employee Form
dDocAuthor=Olson
dSecurityGroup=Public
primaryFile=hr001.doc
DInDate=2/20/99
<<EOD>>
dDocName=HR002
dDocTitle=Payroll Change Form
primaryFile=hr002.doc
DIndate=2/20/99
dRevLabel=3
<<EOD>>

3.9.1.5.3 Update Example 2

This example assumes that one file is already checked into the system with the following metadata:

- Content ID = HR003

- Release Date = 3/15/97

- Revision = 1

- Title = Performance Review

- Author = Smith

Because Revision 1 of the Content ID HR003 exists in the system (and is not in an active workflow), the revision will be updated with the new Title, Author, and Release Date metadata.

Action=update
dDocName=HR003
dDocType=Form
dDocTitle=Performance Review Template
dDocAuthor=Smith
primaryFile=hr003.doc
dIndate=2/20/99
dRevLabel=1
<<EOD>>

3.9.1.6 Optional Parameters

The following table lists the optional parameters you can use in any file record in a batch load file.

In a batchload file, there are two methods you can use to override the primary and alternate formats assigned to a content item checkin:

- Specifying a value for the primaryFile:format parameter, or specifying a value for the alternateFile:format parameter, both. However, it is possible to override these values by using the primaryOverrideFormat or alternateOverrideFormat parameters. It is also possible that certain components will force specific formats on certain types of checkins or certain application functionality may exist in some components that forces a different format.

- Specifying a value for the primaryOverrideFormat parameter, or specifying a value for the alternateOverrideFormat parameter, or both. However, these will only work as parameters in the batch load file if you enable the IsOverrideFormat configuration variable. Note that using this method will override any values that you set for the primaryFile:format and alternateFile:format parameters.

Optional Parameters

Definition

dRevLabel

The metadata field named Revision.
Maximum field length is 10 characters.

Values must be an integer or comply with the Major/Minor Revision Label Sequence established by the System Properties settings (see "Configuring General Options").

dDocAccount

The metadata field named Accounts.
Maximum field length is 30 characters.

This field is not carried over to the next file record.

Do not specify this field if accounts are not enabled.

If accounts are enabled and this field is not specified, dDocAccount will be set to an empty value.

xComments

The metadata field named Comments. Maximum field length is 255 characters.

dOutDate

The metadata field named Expiration Date.
The dOutDate must use the date format of the locale of the user executing the Batch Loader. For example, the English-US date format is mm/dd/yy hh:mm:ss am/pm.

Time information is optional. If you specify the time, only the hh:mm part is required. The ss and am/pm parts are optional.

primaryFile:path

Specifies the location of the file. If a primaryFile:path value is specified, the value overrides the value specified for the primaryFile parameter. However, the primaryFile:path value is not used to determine the file conversion format. If a value for primaryFile:path is not specified, the location is determined from the primaryFile value.
This parameter uses the following syntax:

primaryFile:path=complete_path

primaryFile:format

Specifies the file format to use for the Primary File. This file format overrides the one specified by the file extension of the file and the value specified for the primaryFile parameter. If a primaryFile:format value is not specified, the file format is determined from the file extension for the primaryFile value.
This parameter uses the following syntax:

primaryFile:format=application/conversion_type

alternateFile

The metadata field named Alternate File. The Alternate File name can be a complete path or just the file name. If a file name only is specified, the location of the file is determined as follows:
If the SetFileDir optional parameter has been set in this file record or any previous file record, the directory specified in SetFileDir will be used.

If the SetFileDir parameter has not been set, the batch load file path is used. (The path is specified in the Batch Load File field on the Batch Loader Application.)

alternateFile:path

Specifies the location of the alternate file. If an alternateFile:path value is specified, the value overrides the value specified for the alternateFile parameter. However, the alternateFile:path value is not used to determine the file conversion format. If an alternateFile:path value is not specified, the location is determined from the alternateFile parameter, if a value is specified. Otherwise, by default, the primaryFile value is used for the computation.
This parameter uses the following syntax:

alternateFile:path=complete_path

alternateFile:format

Specifies the file format to use for the Alternate File. This file format overrides the one specified by the file extension of the file and the value specified for the alternateFile parameter. If an alternateFile:format value is not specified, the file format is determined from the file extension for the alternateFile parameter, if a value is specified. Otherwise, by default, the primaryFile value is used for the computation.
This parameter uses the following syntax:

alternateFile:format=application/conversion_type

webViewableFile

The webViewableFile name can be a complete path or just the file name. If a webViewableFile value is specified, then the conversion process is not performed. If a file name only is specified, the location of the file is determined as follows:
If the SetFileDir optional parameter has been set in this file record or any previous file record, the directory specified in SetFileDir will be used.

If the SetFileDir parameter has not been set, the batch load file path is used. (The path is specified in the Batch Load File field on the Batch Loader Application.)

webViewableFile:path

Specifies the location of the Web viewable file. If a webViewableFile.path value is specified, the value overrides the value specified for the webViewableFile parameter. However, the webViewableFile:path value is not used to determine the file conversion format. If a webViewableFile:path value is not specified, the location is determined from the webViewableFile parameter, if a value is specified. Otherwise, by default, the primaryFile value is used for the computation.
This parameter uses the following syntax:

webViewableFile:path=complete_path

webViewableFile:format

Specifies the file format to use for the Web viewable file. This file format overrides the one specified by the file extension of the file and the value specified for the webViewableFile parameter. If a webViewableFile:format value is not specified, the file format is determined from the file extension for the webViewableFile parameter, if a value is specified. Otherwise, by default, the primaryFile value is used for the computation.
This parameter uses the following syntax:

alternateFile:format=application/conversion_type

primaryOverrideFormat

Specifies which file format to use for the Primary File. This file format overrides the one specified by the file extension of the file. This option will only work as a parameter if you enable the IsOverrideFormat configuration variable. You can set this variable by selecting the Allow Override Format in the System Properties application. However, a better (and recommended) alternative would be to use the primaryFile:format parameter.

alternateOverrideFormat

Specifies which file format to use for the Alternate File. This file format overrides the one specified by the file extension of the file. This option will only work as a parameter if you enable the IsOverrideFormat configuration variable. You can set this variable by selecting the Allow Override Format in the System Properties application. However, a better (and recommended) alternative would be to use the alternate File:format parameter.

SetFileDir

Specifies the directory where the Primary Files and Alternate Files are located. This field is carried over to the next file record.

3.9.1.7 Custom Metadata Fields

Any custom metadata field that has been defined in the Configuration Manager can be included in a file record.

- If you have defined any custom metadata fields as required fields, those fields must be defined for an insert action or an update action.

- If a custom metadata field is not a required field, but it has a default value (even if blank), then the default value will be used if the value is not specified in the batch load file.

- When specifying a custom metadata field value, the field name preceded with an x. For example, if you have a custom metadata field called Location, then the batch load file entry will be xLocation=value.

- Keep in mind that some add-on products use custom metadata fields. For example, if you have PDF Watermark, you will have created a field called Watermark. To include this field in a batch load file, precede it with an x just like any other custom metadata field (that is, xWatermark).

3.9.2 Preparing a Batch Load File

This section covers these topics:

- "About Preparing a Batch Load File"

- "Mapping Files"

- "Creating a Batch Load File from the BatchBuilder Screen"

- "Creating a Mapping File"

- "Creating a Batch Load File from the Command Line"

3.9.2.1 About Preparing a Batch Load File

You can use any method you prefer to create a batch load file, if the resulting text file conforms to the batch load file syntax requirements. However, the Batch Loader provides a tool called the BatchBuilder to assist you in creating batch load files.

- The BatchBuilder creates a batch load file based on the files in a specified directory. The BatchBuilder reads recursively through all the sub-directories to create the batch load file.

- A mapping file tells the BatchBuilder how to determine the metadata for each file record. You can use the BatchBuilder to create and save custom Mapping Files.

- You can run the BatchBuilder from the standalone application interface or from the command line.

- The BatchBuilder can also be used to create external collections of content, which are indexed and stored in a separate search collection rather than in the Content Server database. You can set up read-only external collections, where users can search for content but cannot update metadata or delete content. This option is recommended when external content is also included in another Content Server instance.

3.9.2.2 Mapping Files

Mapping files are text files that have a .hda extension, which identifies them as a type of data file used by the content server.

See Oracle Fusion Middleware Developer's Guide for Content Server for more information on HDA files, LocalData properties, and ResultSets.

3.9.2.2.1 Mapping File Formats

The metadata mapping can be defined in one of two formats:

- As name/value pairs in a LocalData definition, a mapping file would look like the following:

@Properties LocalData
dDocName=<$filename$>.<$extension$>
dInDate=<$filetimestamp$>
@end

- As a BatchBuilderMapping ResultSet, a mapping file would look like the following:

@ResultSet SpiderMapping
2
mapField
mapValue
dDocName
<$filename$>.<$extension$>
dInDate
<$filetimestamp$>
@end

3.9.2.2.2 Mapping File Values

The following values can be used in a mapping file:

Value

Description

Example

Normal string

All files will have the specified metadata value.

dDocType=Document
All files will be the Document content type.

Idoc script

Any supported Idoc script. See the Oracle Fusion Middleware Idoc Script Reference Guide for more information.

xLanguage=<$if strEquals(dir2, "EN")$>English<$elseif strEquals(dir2, "SP")$>Spanish<$else$>French<$endif$>

<$dir1$>, <$dir2$>

The directory name at the specified level in the file's path. <$dir1$> refers to the root directory specified in the "Directory" field, <$dir2$> refers to the next level directory, and so on.

dDocType=<$dir1$>
dSecurityGroup=<$dir2$>
dDocAccount=<$dir3$>

If the file path is "f:/docs/public/sales/march.doc" and you have specified the "Directory" value as "f:/docs", the values would be:

<$dir1$> = "docs"
<$dir2$> = "public"
<$dir3$> = "sales"

<$dUser$>

The user currently logged in.

dDocAuthor=<$dUser$>

If sysadmin is logged in, then <$dUser$> would equal "sysadmin".

<$extension$>

The file extension of the file.

dDocTitle=<$filename$>.<$extension$>

If the file path is "d:/salesdocs/sample.doc", then <$extension$> would equal "doc".

<$filename$>

The name of the file.

dDocName=<$filename$>

If the file path is "d:/salesdocs/sample.doc", then <$filename$> would equal "sample".

<$filepath$>

The entire directory path of the file, including the file name.

xPath=<$filepath$>

If the file path is "c:/docs/public/acct/sample.doc", then <$filepath$> is "c:/docs/public/acct/sample.doc".

<$filesize$>

The size of the file (in bytes).

xFileSize=<$filesize$>

For a 42KB file, <$filesize$> would be 43008.

<$filetimestamp$>

The date and time the file was last modified.

dInDate=<$filetimestamp$>

If the last modified date is September 13, 2001 at 4:03 pm, then <$filetimestamp$> would equal "9/13/01 4:03 PM" for an English-US locale.

<$URL$>

The URL of the file, based on the values of the physical file root and relative Web root.

3.9.2.3 Creating a Batch Load File from the BatchBuilder Screen

Use the following procedure to create a batch load file from the BatchBuilder screen:

1. Start the Batch Loader:
Win32: Select Start, the Programs, then Content Server, then instance_name, then Utilities, then BatchLoader.

UNIX: Change to the DomainHome/ucm/cs/bin/ directory, type BatchLoader in a shell window, and press the RETURN key.

The login screen is displayed.

2. Enter the sysadmin user name and password, and click OK.
The Batch Loader Application is displayed.

3. Select Options, Build Batch File.
The BatchBuilder Screen is displayed.

4. In the Directory field, enter the location of the files to be included in the batch load file.

5. In the Batch Load File field, enter the path and file name for the batch load file. You can click the Browse button to navigate to and select the directory and file.

6. From the Mapping list, select a mapping file. To create a new mapping file or edit an existing one, see "Creating a Mapping File".

7. Optional: In the File Filter field, enter filter settings to include or exclude particular files from the batch load file.

8. Optional: To batch load a read-only external collection, select the External check box and select the external collection options.

9. Click Build.

10. When the build process is complete, click OK.

11. Open the batch load file in a text editor and double-check the file records.

12. To save the current batch load file settings as the default, select Options, then Save Configuration.

3.9.2.4 Creating a Mapping File

Use the following procedure to create a mapping file.

1. Display the BatchBuilder Screen.

2. Click Edit next to the Mapping field.
The BatchBuilder Mapping List Screen is displayed.

3. Click Add.
The Add BatchBuilder Mapping Screen is displayed.

4. Enter a name and description for the mapping file, and click OK.

The Edit BatchBuilder Mapping Screen is displayed.

5. Click Add.
The Add/Edit BatchBuilder Mapping Field Screen is displayed.

6. Enter a metadata field name to be defined. For example, enter dDocName for the Content ID field, or xComments for the Comments field.

7. Enter the value for the metadata field.

- Type any constant text and Idoc script directly in the Value field. For example, to set Document as the Type for all documents in the batch load file, enter dDocType in the Field field, and enter Document in the Value field. See the Oracle Fusion Middleware Idoc Script Reference Guide for more information on Idoc Script.

- To add a predefined variable to the Value field, select the variable in the right column and click the << button. For example, to set each document's second-level directory as the Security Group, enter dSecurityGroup in the Field field, and insert the <$dir1$> variable in the Value field.

Caution:
Be careful when choosing predefined variables. Many metadata fields have length limitations and cannot contain certain characters (such as spaces or punctuation marks). See "Managing Repository Content" in the Oracle Fusion Middleware Application Administrator's Guide for Content Server for more information.

8. Click OK.

9. Repeat steps 4 through 8 for as many metadata fields as you want to define.

10. Click OK to save changes and close the Edit BatchBuilder Mapping screen.
The mapping file is saved as MapFileName.hda in the IntradocDir/search/external/mapping/ directory.

11. Click Close to close the BatchBuilder Mapping List screen.

3.9.2.5 Creating a Batch Load File from the Command Line

You can create a batch load file by entering the BatchBuilder parameters from a command line rather than entering them in the BatchBuilder screen. Use the following procedure to create a batch load file from the command line:

1. Open the DomainHome/ucm/cs/bin/intradoc.cfg file in a text editor, and add the following line:

BatchLoaderUserName=sysadmin

This is required so that the system logs in as the system administrator, because only users who have admin rights have permission to run the Batch Loader and BatchBuilder applications.

2. Save and close the file.

3. Open a command line window and change to the DomainHome/ucm/cs/bin/ directory.

Caution:
Run the BatchBuilder using the same operating system account that runs the content server. Otherwise, the software might not process your data due to permissions problems.

4. Enter the following command:
Win32:

BatchLoader.exe /spider /q /ddirectory /mmappingfile /nbatchloadfile

UNIX:

BatchLoader -spider -q -ddirectory -mmappingfile -nbatchloadfile

The following flags can be used with the BatchLoader command to run the BatchBuilder from the command line:

Flag

Required?

Description

-spider or /spider

Yes

Runs the BatchBuilder application.

-q or /q

No

Runs the BatchBuilder in quiet mode in the background. (If the BatchBuilder is run from the command line without this flag, the BatchBuilder screen will be displayed.)

-d or /d

Yes

Directory field value.

-m or /m

Yes

Mapping field value.

-n or /n

Yes

Batch Load File field value.

-e or /e

No

Exclude specified files (Exclude check box selected).

-i or /i

No

Include specified files (Exclude check box clear).

3.9.2.5.1 Win32 Example

The following example shows the correct syntax to run the BatchBuilder from a Win32 command line, where:

- Directory = c:/myfiles

- Mapping File = MyMappingFile

- Batch Load File = c:/batching/batchinsert.txt

- Excluded files = *.exe and *.zip

BatchLoader.exe /spider /q /dc:/myfiles /mMyMappingFile /nc:/batching/batchinsert.txt /eexe,zip

3.9.2.5.2 UNIX Example

The following example shows the correct syntax to run the BatchBuilder from a UNIX command line, where:

- Directory = /myfiles

- Mapping File = MyMappingFile

- Batch Load File = /batching/batchinsert.txt

- Excluded files = index.htm and index.html

BatchLoader -spider -q -d/myfiles -mMyMappingFile -n/batching/batchinsert.txt -eindex.htm,index.html

3.9.3 Running the Batch Loader

This section covers these topics:

- "About Running the Batch Loader"

- "Batch Loading from the Batch Loader Screen"

- "Batch Loading from the Command Line"

- "Using the IdcCommand Utility and Remote Access"

- "Batch Loading Content as Metadata Only"

- "Batch Loader -console Command Line Switch"

- "Adding a Redirect"

- "Adding a Redirect"

3.9.3.1 About Running the Batch Loader

The Batch Loader uses the information from a batch load file to check in (insert), delete, or update a large number of files on your Content Server system simultaneously.

- You can run the Batch Loader from the standalone application interface or from the command line.

- After you run the Batch Loader, the content server processes files through the Inbound Refinery and the Indexer as it would for any other content item.

3.9.3.2 Batch Loading from the Batch Loader Screen

Use the following procedure to batch load content using the Batch Loader screen:

1. Display the Batch Loader Application.

2. Click Browse, and navigate to and select the batch load file.

3. To change the number of errors that can occur before the Batch Loader stops processing, enter the number in the Maximum errors allowed field.

4. To delete files from the hard drive after they are successfully checked in or updated, select the Clean up files after successful check in check box.

5. To create a text file containing the file records that failed during batch loading, select the Enable error file for failed revision classes check box.

6. Click Load Batch File to start the Batch Loader process.
When the batch load process is complete, a Batch Loader message screen is displayed, indicating the number of errors that occurred, if any.

7. If you enabled the error file, write down the file name shown in the message box.

8. Click OK.

9. Correct any problems with the batch load.

10. To save the current Batch Loader settings as the default, select Options, Save Configuration.

3.9.3.3 Batch Loading from the Command Line

You can batch load content by entering the Batch Loader parameters from a command line rather than entering them in the Batch Loader screen. Use the following procedure to run the Batch Loader from the command line:

1. Open the DomainHome/ucm/cs/bin/intradoc.cfg file in a text editor, and add the following line:

BatchLoaderUserName=sysadmin

This is required so that the system logs in as the system administrator, because only users who have admin rights have permission to run the Batch Loader application.

2. Save and close the file.

3. Open a command line window and change to the DomainHome/ucm/cs/bin/ directory.

Caution:
Run the Batch Loader using the same operating system account that runs the content server. Otherwise, the software might not process your files due to permissions problems.

4. Enter the following command:

Win32: BatchLoader.exe /q /nbatchloadfile
Unix: BatchLoader -q -nbatchloadfile

The Batch Loader processes the batch load file, but message boxes will not be displayed.

5. Correct any problems with the batch load.

The following flags can be used with the BatchLoader command from the command line:

Flag

Required?

Description

-q or /q

No

Runs the Batch Loader in quiet mode in the background. (If the Batch Loader is run from the command line without this flag, the Batch Loader screen will be displayed.)

-n or /n

Yes

Batch Load File field value.

-console

No

Echoes all output to the HTML Content Server log and to the console window that is running the Batch Loader. See "Batch Loader -console Command Line Switch" for details.

3.9.3.3.1 Win32 Example

The following example shows the correct syntax to run the Batch Loader from a Win32 command line, where the batch load file is c:/batching/batchinsert.txt:

BatchLoader.exe /q /nc:/batching/batchinsert.txt

3.9.3.3.2 UNIX Example

The following example shows the correct syntax to run the Batch Loader from a UNIX command line, where the batch load file is /batching/batchinsert.txt:

BatchLoader -q -n/batching/batchinsert.txt

3.9.3.4 Using the IdcCommand Utility and Remote Access

Occasionally, you may need to use remote access when managing your Content Server system. This does not necessarily mean that remote terminal access is required. However, you must have the ability to submit commands to the server from a remote location.

Combining remote access with the IdcCommand utility provides a powerful toolset and an easy way to checkin a large number of files to your Content Server. To take advantage of this functionality, you will need to properly set up the workstation to submit commands and be able to use the IdcCommand utility with a batch load command file. This section covers the following topics:

- "Batch Load Command Files"

- "Preparing for Remote Batch Loading"

3.9.3.4.1 Batch Load Command Files

A batch load command file contains a set of commands for each file that is loaded. If you are loading a large number of files, the command file may contain hundreds of lines. Using an editing tool can simplify the task of creating the numerous required lines. For example, the procedure for Preparing for Remote Batch Loading shows how you can prepare a batch load command file using the editing and mail merge features of Microsoft Office.

The following is an example Batch Load Command File:

@Properties LocalData
IdcService=CHECKIN_UNIVERSAL
doFileCopy=1
dDocTitle=thisfile
dDocType=Native
dSecurityGroup=Internal
dDocAuthor=sysadmin
primaryFile=thisfile.xls
xComments=Initial Check In
@end
<<EOD>>@Properties LocalData
IdcService=CHECKIN_UNIVERSAL
doFileCopy=1
dDocTitle=99.tif
dDocType=Native
dSecurityGroup=Internal
dDocAuthor=sysadmin
primaryFile=v:\99.tif
xComments=Initial Check In
@end
<<EOD>>

3.9.3.4.2 Preparing for Remote Batch Loading

To perform batch loading from remote locations, complete the following procedure:

Log In to the Local PC

1. Open Windows Explorer.

2. Create a working directory (for example, c:\working_dir).

3. In the working directory, create one or more directories for the various content servers you will be accessing (for example, c:\working_dir\development and c:\working_dir\contribution).

4. In each of these directories, create a cmdfiles subdirectory.

5. From the remote Content Server instance, copy the following directories (and their files) to your working directory:

- working_dir\idcm1\bin

- working_dir\idcm1\config

- working_dir\idcm1\shared\config\resources\lang

- working_dir\idcm1\shared\config\resources\lang\en

- working_dir\idcm1\weblayout\groups\secure\logs

- In a text editor, open the DomainHome/ucm/cs/bin/intradoc.cfg file and update the IntradocDir configuration variable to match your directory structure (for example, IntradocDir=C:/working_dir/xxS/development/).

- In a text editor, open the IntradocDir/config/config.cfg file and ensure the following settings are correct for the server you are accessing:

IntradocServerPort=4444
IntradocServerHostName=xxsicmsd

- On the remote server, add the IP address of the local PC to the Security Filter, using the Systems Properties utility and restart the server.

Test the Configuration for the Remote Workstation

1. In the cmdfiles directory, create a file named pingservertest.hda and add the following lines:

@Properties LocalData
IdcService=PING_SERVER
@end

1. Open a command prompt and change to your working bin directory (for example, cd C:\working_dir\development\bin

2. Issue the following command:

IdcCommand -f ..\cmdfiles\pingservertest.hda -u sysadmin -l ..\pingservertest.log -c server

1. Confirm the output. If you are successful, you will get the following message from the server.

3/24/04: Success executing service PING_SERVER.
You have completed your setup for remote commands.

Create a Batch Load Command File

This procedure uses the editing and mailmerge features of Microsoft Office to create a batch load command file.

1. Create a file listing of your directory contents:

1. Open a command prompt and change to the root directory representing the files you intend to load.

2. Create a file listing, using the following command to redirect the output into a file:

3. dir /s /b > filelisting.txt

4. Check your filelisting.txt file; it will look something like this:

V:\policies\ADMIN\working_dir_Admin\AbbreviationList.doc
V:\policies\ADMIN\working_dir_Admin\Abbreviations.doc
V:\policies\ADMIN\working_dir_Admin\AbsencePres.doc
V:\policies\ADMIN\working_dir_Admin\AdmPatientCare.doc
V:\policies\ADMIN\working_dir_Admin\AdmRounds.doc
V:\policies\ADMIN\working_dir_Admin\AdverseEvents.doc
V:\policies\ADMIN\working_dir_Admin\ArchivesPermanent.doc
V:\policies\ADMIN\working_dir_Admin\ArchivesRetrieval.doc
V:\policies\ADMIN\working_dir_Admin\ArchivesStandardReq.doc

Note:
When working with batch loads, it is important to note that the file must exist on the server indicated by the primaryFile statement in the batch load command file. Optimally, you should use the same letter to map the directory of files to the server and to your local system. Alternatively, you can copy the directory of files to the server temporarily.

2. Edit the file listing to create your filename and title data:

1. Open your filelisting.txt file in Excel.

2. Using Replace, remove all the directory information leaving only the file name. Also look for and remove the line for filelisting.txt.

3. Copy column A (containing the file names) to column B. In this example the file name is also used for the title and Column B will become the title.

4. Using Replace, remove the file extension from the names in column B.

5. Insert a new first line and enter filename in the first column and title in the second.

6. Save the file.

3. Create an hda file from the file listing using Mail Merge features:

1. Open Word and create a new document with your set of batch load commands. The following example shows basic batch load commands. You must match your configuration settings when you create your batch load commands.

@Properties LocalData
IdcService=CHECKIN_UNIVERSAL
doFileCopy=1
dDocTitle=
dDocType=Native
dSecurityGroup=Internal
dDocAccount=Policy/Admin
dDocAuthor=sysadmin
primaryFile=d:/temp/working_dir_Admin/
xComments=Initial Check In
@end
<<EOD>>

1. Select Tools / Letters and Mailing / Mail Merge Wizard and advance through the wizard. Choose the selections below to use your filelisting.txt file as input to the mail merge.

- Letter Document (step 1)

- Current document (step 2)

- Existing List (step 3) and select your Excel spreadsheet as the data source

- More Items (step 4), place the title and filename fields into the word document so that it looks like the following:

@Properties LocalData
IdcService=CHECKIN_UNIVERSAL
doFileCopy=1
dDocTitle="title"
dDocType=Native
dSecurityGroup=Internal
dDocAccount=Policy/Admin
dDocAuthor=sysadmin
primaryFile=d:/temp/working_dir_Admin/"filename"
xHistory=Initial Check In
@end
<<EOD>>

2. Complete the mail merge (Steps 5 and 6) and you will have a new Word document with one merge record per page.

3. Edit the letters, selecting all, and use the Replace feature to remove all of the section breaks.

4. Save the file as a plain text file to the /cmdfiles directory with the file extension of hda (for example, filelisting.hda)

Execute the Upload

1. Open a command prompt.

2. Navigate to the working bin directory.

3. Issue the command:

IdcCommand -f ../cmdfiles/filelisting.hda -u sysadmin -l ../filelisting.log -c server

Your files will be checked into the content server and a message is displayed in the command window as each file is checked in.

3.9.3.5 Batch Loading Content as Metadata Only

Depending on the action you plan to perform using the Batch Loader, certain fields are required in the batch load file. If you are updating only the metadata in existing content items, the primaryFile field is not required in the batch load file; see "Update Requirements".

However, if you want to load (insert action) content into the Content Server as metadata only, then the primaryFile field is required in the batch load file. Although the field is ignored by the import, the Batch Loader expects it to be defined. If the primaryFile field is missing, you will get an error as follows (or similar):

Please check record number <number>. BatchLoader: unable to check in '<record>' because the required field 'primaryFile' is missing.

To batch load content as metadata only:

1. Open Content Server's config.cfg file:
IntradocDir/config/config.cfg

2. Add the following configuration variables:

createPrimaryMetaFile=true
AllowPrimaryMetaFile=true

3. Save and close the config.cfg file.

4. In the batch load file, add the following field for each record:

primaryFile=

Note that leaving the field blank is acceptable. The field is ignored but must be included.

5. Continue to batch load your content using the Batch Loader procedure or the command line procedure. See "Batch Loading from the Batch Loader Screen" or "Batch Loading from the Command Line".

3.9.3.6 Batch Loader -console Command Line Switch

Adding the -console switch to the Batch Loader command line causes all output to be echoed to the HTML content server log and to the console window that is running the Batch Loader. Alternately, you can use operating system redirects to send the output to a separate log file.

Important:
The -console switch does not follow standard Windows command line syntax (although this may be corrected in later versions). You must use the -console syntax usually associated with UNIX instead of the /console syntax. With most other command line utilities, both syntaxes will work on both platforms.

3.9.3.6.1 Examples

Win32 command line:

BatchLoader.exe /q -console /nc:/batching/batchinsert.txt

UNIX command line:

BatchLoader -q -console -n/u2/apps/batching/batchinsert.txt

Sample output:

Processed 1 of 4 record.
Processed 2 of 4 records.
Processed 3 of 4 records.
Processed 4 of 4 records.
Done processing batch file 'c:/batching/batchinsert.txt'. Out of 4 records processed, 4 succeeded and 0 errors occurred.

3.9.3.7 Adding a Redirect

You can use a redirect symbol on the command line to send the Batch Loader output to a separate log file. The symbol works on both UNIX and Windows. By default, the -console switch sends the Batch Loader's output to stderr. To redirect the output to a different file, use the special redirect symbol 2>.

In the following examples, each command must be entered all on one line.

Win32 command line with redirect:

BatchLoader.exe /q -console /nc:/batching/batchinsert.txt 2> batchlog.txt

UNIX command line with redirect:

BatchLoader -q -console -n/u2/apps/batching/batchinsert.txt 2>
/logs/CSbatchload.log

3.9.3.8 Correcting Batch Load Errors

Use the following procedure to correct any errors that occur during batch loading.

1. Open the content server log. Select Administration, then Log Files, then click Content Server Logs.

2. Look through the Type column for the word Error.

3. Read the description to determine the problem.

4. Fix the error in one of these files:

- Batch load file

- The error file for the failed content. (This option is available only if you enabled it on the Batch Loader Application.) The error file is located in the same directory as the batch load file, with several digits appended to the batch load file name.

Tip:
If you rerun an entire batch load file, content items that have already been checked in will usually fail. This occurs because the release dates of the existing content items will be the same as the ones you are trying to insert.

Figure 3-14 Content Server log file

3.9.4 Optimizing Batch Loader Performance

This section provides some basic guidelines that you can use to improve Batch Loader performance. These suggestions can minimize potentially slow batch load performance when you are checking in a large number of content items. In many cases, proper tuning for batch loading can significantly speed up a slow server.

To minimize batch loading slow downs, try implementing the following Batch Loader adjustments:

- Temporarily disable other activities such as shutting down Inbound Refinery (see the Oracle Fusion Middleware Administrator's Guide for Conversion) and suspending the automatic update cycle feature of the Repository Manager. See "Repository Manager: Indexer Tab".

- Analyze your database usage during a batch load to help the database query optimizer. Databases have built-in optimizer utilities that can help make database queries more efficient. However, to maximize the efficiency of optimizers, it is necessary to update or re-create the statistics about the physical characteristics of a table and the associated indexes. These characteristics include number of records, number of pages, and the average record length. The optimizers use these statistics to access data.
Each database has a proprietary command that you can use to invoke the statistic update or recreation process. For example:

- For Oracle, use the ANALYZE TABLE COMPUTE STATISTICS command

- For SQL Server, use the CREATE STATISTICS statement

- For DB2, use the RUNSTATS command

3.9.4.1 Example: Best Practice Case Study

This case study describes a very slow load batch performance and the steps taken to diagnose and correct the situation. This information can serve as a model for isolating underlying issues and resolving batch loading performance problems.

3.9.4.1.1 Background Information

A user wanted to load 27,000 content items into Content Server that was running on an AIX server. The DB2 database was running on a separate AIX server. The content items included TIFs as the native files and corresponding PDFs as the Web-viewable files. Inbound Refinery generated thumbnails from the native files.

Initially during the batch load, the performance was acceptable with sub-second insert times. However, after a few thousand content items were loaded, the performance began to degrade. Content items started to require a few seconds to load and, eventually, the load time was over 10 seconds per content item.

3.9.4.1.2 Preliminary Troubleshooting

While the batch load was running, nothing seemed to be wrong with the Content Server system. It had sufficient memory, the CPU utilization was low (less than 5%), and there were no disk bottlenecks. The Inbound Refinery server was busy, but was processing thumbnails at an acceptable rate.

Two issues were found with the database server:

- Two processes were taking turns to update the database. While one process was executing, the second process waited for other process to release database locks. When the first process completed, the second process executed while the first process waited. The processes in this execute/wait cycle included:

- The actual batch load process that was updating the database tables after inserting a content item.

- The Content Server was updating the database tables; changing the status from GENWWW to DONE after receiving notification that a thumbnail had been completed.

The two processes should not have been contending with each other because they were not updating the same content items. It seemed that the two processes were locking each other out because DB2 had performed lock escalation and was now locking entire database pages instead of single rows.

- There were a large number of tablespace scans being performed by both processes.

3.9.4.1.3 Solution

A two-step solution was used:

1. Inbound Refinery was shut down to prevent the status update process from competing with the batch loading process. The performance did improve because there was a 2000+ backlog of content items from the completed thumbnails.

2. A RUNSTATS command was issued on all the Content Server database tables to update the table statistics. This dramatically improved the performance of the batch load. The insert time returned to sub-second and the batch load completed within a short amount of time. It took 21 hours to insert the first 22,000 content items. After updating the table statistics, the remaining 5,000 content items were inserted in 13 minutes.

3.10 Finding Error and Status Information

Effective troubleshooting relies on the availability of useful, detailed information. The Content Server products provide various sources of information that may be helpful in the troubleshooting process.

This section covers the following topics:

- "Log Files"

- "Configuration Information"

- "System Audit Information"

- "Tracing"

- "Environment Packager"

- "Content Server Analyzer"

- "Using Content Server Analyzer"

- "Configuration Debug Entry"

- "Stack Traces"

3.10.1 Log Files

Content Server stores status information and errors in log files. Log files are used to register system events, with their date and time of occurrence. They can be valuable tools for troubleshooting, especially if verbose logging is turned on. Not only do logs indicate that specific events occurred, they also provide important clues about a chain of events that led to an error or problem.

Note:
When applied to process log output, verbose logging can quickly increase the size of a log file and possibly cause the content server to slow down. It is recommended that for process logs, verbose logging is only used when troubleshooting a specific issue. Regular content server logs do not have this issue with verbose logging.

Information is also captured in logs controlled by Oracle WebLogic Server using Oracle log APIs. The Oracle UCM interface provides access to these logs. For details, see "Viewing Log Information for Oracle UCM Content Server".

This section covers the following topics:

- "Log File Characteristics"

- "Accessing the Log Files"

- "Using Content Server Logs"

- "Using Archiver Logs"

3.10.1.1 Log File Characteristics

The log files associated with Content Server have the following characteristics:

- They are created only once each day at the time the first status, error, or irrecoverable error occurs.

- No empty log files are generated.

Each log file contains the following columns:

- Type: Specifies the kind of incident that prompted the log entry: Information, Error, or Fatal.

- Time: Lists the date and time the log entry occurred.

- Description: Describes the incident that occurred.

The log files are standard HTML pages and are maintained for each content server instance. Logs are kept in revolving file name format for a maximum of 30 files. When the 31st file is created, the oldest one is deleted. Therefore, log file names in Content Server bear no relation to the date they were generated. To find a certain day in the log file, view the index file in a browser and select that day's link. The file name is displayed in the browser's status bar (if it is enabled).

Tip:
Bookmark your log file pages. This will help you to troubleshoot problems, even if the content server is unavailable. Also, know where your configuration files are so you can find them if the content server is unavailable.

3.10.1.2 Accessing the Log Files

The log files of a content server are normally accessed from the Log Files folder in the Administration tray.

Note:
You must be logged into the content server as an administrator to be able to view the log files.

If, for whatever reason, you cannot view the log files from the Administration tray, you can also access them on the file system of the content server computer. The log files are located in the following locations:

Log Files

Found in:

Content Server

IntradocDir/weblayout/groups/secure/logs

Console Output Logs

IntradocDir/bin/classname.log

Refinery

IntradocDir/weblayout/groups/secure/logs/refinery

Archiver

IntradocDir/weblayout/groups/secure/logs/archiver

3.10.1.3 Using Content Server Logs

The content server logs are listed by date and time. One file is generated for each day. Entries are added to the file throughout the day as events occur.

The following types of server log entries are generated:

- Info: Displays basic status information. For example, status information is logged if the server is ready and waiting.

- Error: Displays errors that occur but do not stop the software from functioning. For example, an error is logged if a user requests secure information that they are not allowed to access.

- Fatal: Displays errors that stop the software from functioning. For example, a fatal error is logged if the content server cannot access the database.

To open a Content Server log:

To open a server log, complete the following steps:

1. Ensure that you are logged into Content Server as an administrator.

2. Click Content Server Logs on the Administration page or in the Administration tray's Log Files folder.
The Content Server Logs Screen is displayed.

3. Select the link that corresponds to the date and the time of the log that you want to view.

3.10.1.4 Using Archiver Logs

Archiver logs show information about imports, exports, and replications. The Archiver logs are listed by date and time. They are generated once a day when the first Archiver information status, fatal error, or error occurs.

The following types of archiver log entries are generated:

- Info: Displays basic status information. For example, status information is logged when an export and an import starts and finishes.

- Error: Displays user/administration errors that occur but do not stop the software from functioning. For example, an error is logged if there is no file information for a content item that you are trying to export.

- Fatal: Displays errors that stop the software from functioning. For example, a fatal error is logged if the content server cannot access the database. Check the connection string, user name, and password.

To open an Archiver log:

To open an Archiver log, complete the following steps:

1. Ensure that you are logged into Content Server as an administrator.

2. Click the Archiver Logs link, found on the Administration page or in the Administration tray's Log Files folder.
The Archiver Log Screen is displayed.

3. Select the link that corresponds to the date and the time of the log.
A table showing the type, date and time, and description of each action is displayed. It also includes the name of the content server instance that created the archive.

3.10.1.5 Inbound Refinery Logs

With the release of Inbound Refinery version 11gR1, all Refinery logging is accessed through the Inbound Refinery interface. For more information see the Oracle Fusion Middleware Administrator's Guide for Conversion.

3.10.2 Configuration Information

Content Server provides a Configuration Information Page that displays configuration information for a Content Server instance, which may be useful while troubleshooting a problem or working with the Oracle support organization. To access this page, click Administration in the portal navigation bar, then click Configuration for [Instance]. To display more information, click the link for each type of configuration information.

The following configuration information is presented:

- Server information, such as name, description, and host filter.

- Installation directories, such as the locations of the core Content Server software, the native file repository ('Vault'), and the Web-viewable file repository ('Web Layout').

- Internet properties, such as the mail server and HTTP server names.

- Database properties, such as the JDBC driver name and the JDBC connection string. Because Content Server uses an Oracle WebLogic Server data sore for the database connection, this information might not be displayed. If you do not see database connection information, check the Oracle WebLogic Server Administration Console.

- Version and build information, such as the Content Server version and Java version.

- License properties, such as the serial number and feature code.

- Server options, which lists the current value of several server-specific options.

- Content Security options, which specify what users can do with content.

- Java properties, such as the JVM vendor and version.

- Server components, which lists all components that are currently enabled for the content server instance.

Note:
Some options are specified during the software installation, while others are set using the System Properties utility.

3.10.3 System Audit Information

Content Server provides a System Audit Information Page for a Content Server instance, which may be useful while troubleshooting a problem or tweaking a server's performance. To access this page, click Administration in the portal navigation bar, then click System Audit Information.

The System Audit Information page has five sections:

- System Audit General Information

- System Audit Localization Information

- System Audit Tracing Sections Information

- System Audit Cache Information

- System Audit Configuration Entry Information

- System Audit Component Report Information

3.10.3.1 System Audit General Information

The General Information section of the System Audit Information page provides the following:

- Information regarding whether the system is receiving too many requests. If it is receiving too many requests, an e-mail is sent to the system administrator regarding load performance.

- Information about the memory cache for the system, and is useful in troubleshooting any "out of memory" errors you may receive. This is important when running the content server with many users and a large quantity of data.

- Information about which Java threads are currently running. This is useful in determining the cause of an error.

- Information about database activity.

- Listing of any audit messages.

To display more information, click the link for the type of configuration information.

Figure 3-15 System Audit General Information Screen

3.10.3.2 System Audit Localization Information

The Localization Information section of the System Audit Information page provides information on:

- String key count

- Whether the Localization system is using a string index

- Localization test run time

- Localization test lookups per second

Figure 3-16 System Audit Localization Information Screen

3.10.3.3 System Audit Tracing Sections Information

Tracing in Content Server can be activated on a section-by-section basis. Tracing for active sections is displayed on the Server Output Page. Section tracing is useful for determining which section of the server is causing trouble, or when you want to view the details of specific sections. Sections can be added by appending extra sections to create a comma separated list. A listing of the sections available for tracing, with brief descriptions, is available by clicking the 'i' next to the Tracing Sections Information heading. The wildcard character * is supported so that schema* will trace all sections that begin with the prefix schema.

Some tracing sections also support verbose output. Enable Full Verbose Tracing if you want to see in-depth tracing for any active section that supports it. See "Tracing" for more information.

Figure 3-17 System Audit Tracing Sections Information Screen

Important:
Any options set here will be lost when the content server is restarted unless you enable Save and click Update.

3.10.3.4 System Audit Cache Information

Content Server caches various items for quick access. The Cache Information section displays current information of three main caches:

- Searches: This pertains to the number of searches currently being run, how many executed searches are currently in cache, and when the cache is emptied. These details are useful when troubleshooting any search related issues.

- Schema: This lists details of any schema items currently in cache.

- Buffer: This displays information about Java objects in cache and how much memory each object is using, which is reflected in the memory information under the System Audit General Information section. This information can be useful in pinpointing which object may be responsible for any memory leaks or other memory issues.

To display more information, click the link for the type of cache information.

Figure 3-18 System Audit Cache Information Screen

3.10.3.5 System Audit Configuration Entry Information

The Configuration Entry Information section of the System Audit Information page provides information on:

- Number of environment keys

- Number of overwritten config values

- Number of ignored settings

- Number of removed settings

To display more information, click the link for the type of configuration entry information.

Figure 3-19 System Audit Configuration Entry Screen

3.10.3.6 System Audit Component Report Information

The Component Report Information section of the System Audit Information page provides the following information for components on a content server instance:

- Location: pathname for the component in the instance

- Version: date, build, and revision

- Status: current status of the component (Loaded or Skipped)

- Reason: an explanation of the component status

To display more information, click the link for the component name.

Figure 3-20 System Audit Component Report Screen

3.10.3.7 Server Output Page

The server output page displays the console output of Content Server. This is the same information that is located in the DomainHome/ucm/cs/bin/classname.log file. It includes information pertaining to all the sections selected for audit tracing in the System Audit Tracing Sections Information. To access the Server Output page, click View Server Output on the System Audit Information page.

Figure 3-21 Console Output Page

3.10.3.8 Localization Audit Page

The Localization Audit page is accessed by clicking Localization Auditing on the System Audit Information page. It displays information regarding the availability of localized variables for the Content Server user interface, and is useful in determining if any custom metadata field labels or other customized Content Server text requires localization. Clicking Show in the Stack Trace column displays the generated Java exceptions. Localization auditing is not persistent and must be started and stopped when using it.

Figure 3-22 Localization Audit Page

3.10.4 Tracing

You can activate Content Server tracing to display detailed system information that may be very useful for troubleshooting and optimizing system performance. There are two options:

- Server-Wide Tracing

- Applet-Specific Tracing

3.10.4.1 Server-Wide Tracing

Server-wide tracing is used to view activities throughout the system.

There are two ways to activate server-wide tracing. To activate tracing from the Administration page, complete the following steps:

1. Ensure that you are logged into Content Server as an administrator.

2. Click the System Audit Information link in the Administration tray.

3. Enable Full Verbose Tracing to see in-depth tracing for any active section that supports it.

4. Specify the traces to activate.

5. Click Update.

6. Click View Server Output.

Tip:
Tracing options are lost on system restart. To ensure your settings are retained after restarting the content server, enable Save before clicking Update.

To activate tracing from an applet, follow these steps:

1. Start an administrative applet.

2. Select Options and then Tracing.

3. Select Server tracing.

4. Select the tracings to activate or all and click OK.

The following tracing options are available. Additional tracing sections can be displayed in the list if components are added.

- applet: This trace contains result sets from initialized applets, such as the Configuration Manager or User Admin.

- archiver: This trace provides information about archiving activities, including the reading and writing of archiver data files and the time the activities were initiated and finished.

- archiverlocks: This trace provides information about the locks put on files during archiving activities, including time initiated.

- chunkedrequest: This trace displays the messages and headers that are created when large requests are 'chunked' into smaller requests.

- docprofile: This trace displays the computation of content profiles, specifically the evaluation of the rules that determine which fields are labels, hidden, and so on.

- encoding: This trace provides information about encoding transformations that have occurred and the activities where encoding occurred.

- filelock: This trace displays information about short-term system locks put on directories (during activities like archiving, for example) with a focus on collisions that occur and time outs.

- filelonglock: This trace displays information about the creation, removal, and maintenance of long term locks imposed by the system.

- filequeue: This trace displays information about accesses to a file queue.

- indexer: This trace displays information about index functions that occur when the database is updated, including the steps taken to update the index and the time elapsed for each step.

- indexermonitor: This trace provides a brief summary of automatic index activities, including time started and ended.

- indexerprocess: This trace displays information about a manually launched index process and indicates if the process terminated properly.

- localization: This trace displays information about localization usage and activities.

- mail: This trace describes mail sent by the content server.

- pagecreation: This trace displays information about the creation of displayed pages, including the server thread and the time taken to generate the page.

- requestaudit: This trace provides summary reports on service requests, including the elapsed time for the requests and the number of requests made.

- scheduledevents: This trace provides a list of hourly or daily background scheduled events.

- schema: This trace provides information about schema publishing (tables and views published as .js files) and caching (tables cached into Content Server memory).

- searchquery: This trace displays information about recent searches, including the fields used to search on and the order of sorting for results.

- socketrequests: This trace displays the date, time, and thread number of socket requests and the actions during the request.

- system: This trace displays internal system messages, such as system socket requests and responses.

- systemdatabase: This trace provides information about database activities, including queries executed, index updates, threads used, and time initiated.

- transfermonitor: This trace displays information about the archiver and the batch file transfer activities.

- userstorage: This trace describes the access of external user repositories, including what actions were taken during access.

- workflow: This trace displays a list of metadata on content items going through workflow, including document title and revision number.

Note:
To facilitate international support, most tracing messages are in English and do not have translations.

3.10.4.2 Applet-Specific Tracing

For applet-specific tracing, the output goes to the browser Java console. To perform tracing by applet, complete the following steps:

1. Start the administration applet to be traced.

2. Select Options and then Tracing.

3. Make your selections, and click OK. The output is directed to the browser Java console.

Figure 3-23 Applet-specific Tracing

3.10.5 Environment Packager

The Environment Packager is a diagnostic tool. It creates a zip file of the desired state directories, log files, and other component and resource directories.

To create an environment zip file, complete the following steps:

1. Ensure that you are logged into Content Server as an administrator.

2. From the Administration tray, click the Environment Packager link. The Environment Packager Page is displayed.

1. Select which parts of the environment should be packaged.

2. When you are ready to create the environment zip file, click Start Packaging.
A message is displayed while the zip file is being built, with a link to the zip file. The packaging process may take several minutes. The zip file link will not be available until the process has finished.

Note:
The packaged zip is named server_environment_*.zip. While Content Server builds the packaged zip file, it will be located in IntradocDir/vault/~temp. When the build of the zip file is complete, it is moved to IntradocDir/weblayout/groups/secure/logs/env.

3.10.6 Content Server Analyzer

Content Server Analyzer is a utility that enables you to confirm the integrity of the Content Server repository components, including the file system, database, and search index. It can also assist system administrators in repairing some problems that are detected in the repository components.

The Content Server Analyzer utility enables system administrators to do any of the following:

- Confirm the accuracy of synchronization between three important Content Server database tables (Revisions, Documents, and DocMeta).

- Confirm that the dRevClassID and dDocName fields are consistent across all revisions of content items.

- Determine if the file system (native and Web-viewable file repositories) contains any duplicate or missing files.

- Ensure the accuracy of synchronization between the search index and the file system.

- Ensure the accuracy of synchronization between the search index and the Revisions database table.

- Ensure that the file system contains all necessary files.

- Remove duplicate files from the Content Server repository either permanently or provisionally by moving them into the logs/directory.

- Produce a general report on the state of content items in the content server.

The method to start the Content Server Analyzer depends on the operating system:

- Windows: Select Start, then Programs, then Content Server, then Instance_Name, then Utilities and then Content Server Analyzer.

- UNIX: Change to the DomainHome/ucm/cs/bin directory and run the Content Server Analyzer program.

3.10.7 Using Content Server Analyzer

This section describes the following Content Server Analyzer tasks:

- "Accessing the Content Server Analyzer"

- "Specifying a Custom Analyzer Log Directory"

- "Invoking the Analysis Process"

- "Analyzing the Content Server Database"

- "Analyzing the Content Server Search Index"

- "Analyzing the Content Server File System"

- "Viewing the Analysis Progress and Results"

- "Generating a Status Report"

- "Canceling the Status Report"

3.10.7.1 Accessing the Content Server Analyzer

To display the Content Server Analyzer, use one of the following methods:

- Windows: Select Start, then Programs, then Content Server, then instance_name, then Utilities and then Content Server Analyzer.

- UNIX: Change to the DomainHome/ucm/cs/bin directory, type IdcAnalyze in a shell window, and press the RETURN key.

The Content Server Analyzer application is displayed.

3.10.7.2 Specifying a Custom Analyzer Log Directory

The logs/ directory is the default logging directory for the Content Server Analyzer. Analysis output files are written to this directory and extra files detected during a file system analysis process can be transferred here as well. Optionally, the default logs/ directory name and path can be changed as desired.

To customize the Analyzer log directory name and path:

1. On the Content Server Analyzer: Configuration Tab, place the cursor in the Analyzer log dir field.

2. Enter the desired directory path.
During the next analysis process, the Content Server Analyzer automatically creates the specified directory or directories in the DomainHome/ucm/cs/bin/ directory hierarchy.

3.10.7.3 Invoking the Analysis Process

To invoke the analysis process:

1. On the Content Server Analyzer: Configuration Tab, select and activate the desired options (checking the corresponding check boxes).

2. Click Start Analysis.

Note:
If this is the very first time the Content Server Analyzer has been run, the output files in the logs/ directory are automatically created. On subsequent analysis processes, a confirmation message is displayed asking to overwrite the existing log file.

3. Click Yes to overwrite the existing log file.
The Content Server Analyzer: Progress Tab is displayed automatically.

Note:
If you click No, the analysis process is terminated and you are prompted to manually remove files from the logs/ directory before running the Content Server Analyzer again.

A completion message is displayed when all of the selected analysis processes are finalized.

4. Click OK.
The results are displayed in the console area on the Progress tab.

3.10.7.4 Analyzing the Content Server Database

These options are used to check the integrity of the database columns. The available options enable users to examine the three tables that are used to store content item revision information (DocMeta, Documents, and Revisions). The DocMeta file is examined for extra entries that are not found in the Revisions table. Similarly, the Documents table is examined to verify that there are sufficient entries to correspond to the entries in the Revisions table.

Note:
The Check RevClassIDs and Clean database options are activated and selectable only when the Check database option is selected.

To analyze the Content Server database:

1. On the Content Server Analyzer: Configuration Tab, select the applicable options.

2. Click Start Analysis.
The results are displayed in the console area on the Content Server Analyzer: Progress Tab. See "Invoking the Analysis Process" for information about the analysis procedure.

3.10.7.5 Analyzing the Content Server Search Index

These options are used to check the entries in the Revisions table to ensure that all of the documents that belong in the index are properly listed. Additionally, a check can be performed to ensure that there are no duplicate entries in the search index.

Note:
The csIDCAnalyzeCleanIndex option is activated and selectable only when the Check search index option is selected.

To analyze the Content Server search index:

1. On the Content Server Analyzer: Configuration Tab, select the applicable options.

2. Click the Start Analysis button (refer to "Invoking the Analysis Process" for information about the analysis procedure).
The results are displayed in the console area on the Content Server Analyzer: Progress Tab.

3.10.7.6 Analyzing the Content Server File System

These options check the integrity of the file system (weblayout and vault file repositories). Using the information in the database, these options ensure that every file in the Revisions table contains accurate entries corresponding to the items in the file system. A check can also be completed to locate any extra files in the vault and weblayout file repositories.

Note:
The Delete, Safe delete, and Check for extra files options are activated and selectable only when the Check file system option is selected.

To analyze the Content Server file system (vault and weblayout file repositories):

1. On the Content Server Analyzer: Configuration Tab, select the applicable options.

2. Click Start Analysis.
The results are displayed in the console area on the Content Server Analyzer: Progress Tab. See "Invoking the Analysis Process" for information about the analysis procedure.

3.10.7.7 Viewing the Analysis Progress and Results

The Content Server Analyzer: Progress Tab is displayed automatically when the Start Analysis button is clicked. The progress bars show when the Content Server Analyzer has completed processing the selected analysis options. The following image shows a partially finished analysis:

When the analysis process is complete, the results are displayed in the console area of the Progress tab. The results depend on what analysis options were selected. The following image of the console area shows the results from selecting database, search index, and file system options:

Note:
The Generate report option was not selected for this example (refer to "Generating a Status Report" for an example of the generated status report).

Figure 3-24 Example Console Display of Results

3.10.7.8 Generating a Status Report

The status report generated by the Content Server Analyzer provides statistics about the content items in the repository. The status report output is displayed in the console area of the Progress tab.

To generate a status report:

1. On the Content Server Analyzer: Configuration Tab, select the Generate report check box.

2. Click Start Analysis.
When the analysis process is complete, the status report information is displayed immediately following the standard analysis results in the console area of the Content Server Analyzer: Progress Tab.

3.10.7.9 Canceling the Status Report

The report generation feature can be suppressed after the analysis process has already started. To cancel the content item status report during the analysis process:

1. During the analysis process, click Cancel on the Content Server Analyzer Application.
You are prompted about canceling after the current task is finished.

2. Click Yes to suppress the status report.
The status report is not included with the analysis results that are displayed in the console area of the Progress tab.

3.10.8 Configuration Debug Entry

Content Server also provides a debugging configuration variable that, when set, contributes applicable diagnostic information. The configuration variable is named IsDevelopmentEnvironment, and it is set in the Content Server's configuration file (IntradocDir/config/config.cfg) during installation and when Content Server is updated. This entry does the following:

- Defines whether Content Server should run in debug mode.

- Enables a trace of script errors. If used as a parameter to a service call, script error information can be added to the bottom of the displayed page.

Another debug configuration variable is named AlwaysReportErrorPageStackTrace. When this variable is set, whenever an error occurs the stack trace is reported on the browser showing the Content Server user interface.

Note:
For further details refer to the Oracle Fusion Middleware Idoc Script Reference Guide.

3.10.9 Stack Traces

The stack trace enables you to see what threads are currently running in the Oracle Content Server. It is a useful troubleshooting tool that provides information about the threads and enables you to monitor the Content Server's processing.

For instructions to initiate a current stack trace for a Content Server instance, see Oracle WebLogic Server documentation.

4 Managing Security and User Access

This chapter covers the following topics:

- "Introduction to Oracle UCM and Content Server Security"

- "Configuring Security for Oracle UCM and Content Server"

- "Security Groups, Roles, and Permissions"

- "Accounts"

- "User Logins and Aliases"

- "Security and Content Server Providers"

- "Additional Content Server Security Connections"

- "Content Server Communication Customization"

4.1 Introduction to Oracle UCM and Content Server Security

Content Server is deployed on an Oracle Universal Content Management (Oracle UCM) domain, which is deployed on an Oracle WebLogic Server domain on Oracle Fusion Middleware. Security is supported at multiple levels including Content Server, Oracle WebLogic Server, and Oracle Platform Security Services.

Access to content in the Content Server repository requires a Content Server administrator to manage content, users, and groups, as well as roles, permissions, and accounts. An Oracle WebLogic Server administrator functions as the Content Server administrator. The Oracle WebLogic Server administrator must log in to Content Server and set up the primary Content Server administrator account and password, if no such user was configured during deployment. Once the Content Server administrator is configured, then content management tasks can be performed on Content Server.

Most user management tasks must be performed with the Oracle WebLogic Server Administration Console rather than the User Admin applet in Content Server. By default, Oracle UCM uses the Oracle WebLogic Server user store to manage user names and passwords, and the credential store is leveraged to grant users access to Content Server. Oracle Platform Security Services provides alternatives to the default Oracle WebLogic Server user store, such as Oracle Internet Directory, which can support users and passwords for an enterprise level system.

Content Server offers two levels of security for repository content: security groups (which are required) and accounts (which are optional). Every content item is assigned to a security group, and if accounts are enabled, then content items can also be assigned to an account. Users are assigned a certain level of permission (Read, Write, Delete, or Admin) for each security group and account, which enables them to work with a content item only to the extent that they have permissions to the item's security group and account.

This section covers the following topics:

- "Security Features"

- "Types of Users"

- "Content Server Security Recommendations"

4.1.1 Security Features

This section covers the following topics:

- "Security Integration with Oracle WebLogic Server"

- "Security within Content Server"

- "Additional Security Options"

4.1.1.1 Security Integration with Oracle WebLogic Server

With 11g Release 1 (11.1.1) of Oracle Universal Content Management (Oracle UCM), Content Server is deployed on an Oracle WebLogic Server domain and uses Oracle Platform Security Services (OPSS) to authenticate and manage user access through Oracle WebLogic Server.

If you have used earlier versions of Content Server, be aware of the following changes to security:

- During Oracle WebLogic Server installation and configuration, a default administration user must be specified. When this user first logs in to Content Server, a password is not required, however, the Post Installation Configuration Page is displayed for further configuration and to specify a Content Server administrator login and password.

- When Content Server is installed, a JpsUserProvider is set up by default to communicate with the Oracle WebLogic Server user store for user authentication and access.

- All users authenticated through external security (using JpsUserProvider with Oracle WebLogic Server or another provider with Oracle WebLogic Server) are considered external Content Server users. The first time users log in to Content Server they are added to the Content Server database, and administrators can view external user information through the Repository Manager. However, external users are not automatically included in user lists, such as the Author field on a content Check In page.

- By default, Content Server uses the Oracle WebLogic Server user store to manage user names and passwords. Most user management tasks must be performed with the Oracle WebLogic Server Administration Console instead of Content Server's User Admin applet. Although a Content Server administrator can use the User Admin applet to create local users and assign passwords and roles on Content Server, for local users to be authenticated for access to Content Server they must also be created and assigned passwords and roles using Oracle WebLogic Server.

Note:
Any user created solely in Content Server is not recognized by Oracle WebLogic Server.

- The Oracle WebLogic Server user store also manages some additional user metadata such as email and display names. You can use the Oracle WebLogic Server admin server interface to edit these values. The value settings can be found in the interface for the Oracle WebLogic Server domain SecurityRealm, realm name, Users and Groups, user name, Attributes tab.
User metadata can be changed in Content Server, but only after users have logged in to Content Server at least one time to establish themselves as users in Content Server. After the first login, users can update their User Profile page, or a Content Server administrator can set user attribute values with the User Admin applet.

- Users can be assigned groups in Oracle WebLogic Server. When a user logs in to Content Server, the user's groups are mapped to Content Server roles. For Oracle WebLogic Server groups to be recognized in Content Server, roles with the exact same names must be created in Content Server and assigned to security groups. If this is not done, the Oracle WebLogic Server groups assigned to users has no impact on users' privileges in Content Server.

- It is recommended that any configuration with an external user store, such as an LDAP server, is performed with the Oracle WebLogic Server administration server instead of Content Server. Oracle WebLogic Server uses an embedded LDAP server, but also can be configured to work with other LDAP servers such as Oracle Internet Directory. Integration with an external user store applies to the domain, including all its servers; the Oracle WebLogic Server Admin Server could be shut down, and Oracle UCM and other applications could continue to use the configured LDAP server.

For more information on security integration and configuration, see "Configuring Security for Oracle UCM and Content Server".

4.1.1.2 Security within Content Server

Administrators set up initial user and content security within Content Server by using the User Admin application to define user roles, permissions to groups, and accounts. Oracle WebLogic Server is used to create user accounts and assign each user to one or more of the roles, which in turn are assigned specific permissions to security groups. If accounts are enabled, administrators can assign each user specific permissions to certain accounts, which then limits the permissions they might otherwise have through their assigned roles.

For details, see "Security Groups, Roles, and Permissions", "Accounts", and "User Logins and Aliases".

The following components also can be used to provide additional internal Content Server security:

- Security can be customized for user access by using the ExtranetLook component, which is installed (disabled) with Content Server. See "Login/Logout Customization" for details.

Note:
The ExtranetLook component is not applicable when Oracle WebLogic Server is used as the Web server for Content Server. Modification of the security implementation is controlled through direct customization of the Oracle WebLogic Server and Administrative configuration.

- Security can be customized for user access and search results by using the Need to Know component. This component enables you to further configure user access restrictions, modify the display of search results, alter search behavior, and set up hit list roles. To use this component, you must install and enable it. For more information, see Appendix B, "Need to Know Component".

Be aware that Internet Explorer 7 supplies the following message to users logging in with basic authentication without a secure connection:

Warning: This server is requesting that your username and password be sent in an insecure manner

The behavior (sending username and password in text) is not new for basic authentication and does not cause problems.

4.1.1.3 Additional Security Options

Content Server can combine authentication methods. For example, you can define some users in Oracle WebLogic Server, allow some users to log in using their Microsoft domain identity, and grant other users Content Server access based on their LDAP credentials. However, authentication is configured through Oracle WebLogic Server, so the combination of methods is limited. Users can authenticate against multiple authentication stores, but because of the Oracle Platform Security Services and Oracle WebLogic Server integration, only one of the configured user stores can be used to extract authorization (group) information.

The following options can be used to provide additional security:

- Security can be customized to support encrypted socket communication and authentication by using the Security Providers component, which is installed (enabled) by default with Content Server. This component enables a Secure Sockets Layer (SSL) provider, which can be configured to use certificates for socket or server authentication.
If you use SSL and HTTPS to connect to Content Server, and are unable to connect through WebDAV, try connecting to the Content Server through the browser using the same URL you used in your WebDAV connection string. This lets you see if there is a problem with the certificate, which is used to encrypt communications. If you get a dialog box stating a problem with the certificate, resolve the issue and then try to connect through WebDAV again.

- For users to access Content Server using different Web server front ends, when one server front end is HTTPS and the other is HTTP, customize the Content Server configuration using the BrowserUrlPath component. This component is installed (disabled) by default with Content Server and supports a Web server front end using HTTPS and a load balancer that forwards itself as the HTTP Host header. If you only use one access method (only HTTPS, or only HTTP), or you are not using a load balancer that blocks the "Host" parameter from the browser, then this component is unnecessary. For more information see "Browser URL Customization".

- Extended security attributes can be assigned to external users or to users for a specific application. The extended attributes are merged into pre-existing user attributes and enable additional flexibility in managing users. For more information see "Extended User Attributes".

- Content Server can be customized to filter data input for illegal or corruptive HTML constructs. For more information see "Filter Data Input".

In all environments, a comprehensive understanding of your organization's security needs and a thorough planning phase is crucial to a successful security integration.

4.1.2 Types of Users

User access to Content Server can be set up in multiple ways, but user authentication can only be managed with Oracle WebLogic Server. Content Server supports the following user types:

- "External Users"

- "Local Users"

4.1.2.1 External Users

External users are defined outside the Content Server system and authenticated by external security with Oracle WebLogic Server. Once authenticated, external users can use the Oracle UCM login screen to access Content Server. Generally, external users are users in a trusted domain to whom you grant access and do not manage through Content Server. Their passwords are owned by the Oracle WebLogic Server, the network domain, or another provider, although the User Admin applet can be used to set a user password when converting an external user to a local user. Unlike local users, undefined external users are not assigned the guest role.

The first time users log in to Content Server they are added to the Content Server database, and administrators can view external user information through the Repository Manager. However, external users are not automatically included in user lists, such as the Author field on a content Check In page. If an Override check box is selected on a user's User Profile page, any user information defined in the Content Server database overrides the user information derived from the external user base.

The Admin User applet only shows users after they have logged in at least one time to Content Server. All users from the Oracle WebLogic Server user store are shown as external users.

By default, external security integrations map a limited set of user information (user name, password, roles, accounts, and some additional information such as e-mail address) from the external user base to the Content Server. If you are using LDAP integration, then additional user information, such as e-mail address or user locale, can be mapped from the embedded LDAP server in Oracle WebLogic Server and integrated with Oracle Platform Security Services.

The following is a list of common characteristics of external users:

- Login is Defined By: Participation in an external user database.

- Trusted domain (such as Oracle WebLogic Server)

- Other database

- Access is Determined By: Credentials from a trusted domain or other user base (such as the Oracle WebLogic Server user store or LDAP).

- User Login: Oracle WebLogic Server and Content Server must be running for users to log in.

- User password: User passwords are defined on Oracle WebLogic Server or another user base (such as an LDAP server) by the administrator. Users cannot change their passwords on Content Server.

- Interface Issues: User names do not appear in the content check-in lists. However, users can participate in workflows.

Follow these steps to set up roles, groups, and accounts for external users:

1. Set up security groups. See "Adding a Security Group on Content Server".

2. Establish roles. See "Creating a Role on Content Server".

3. Arrange permissions. See "Adding and Editing Permissions on Content Server".

4. (Optional) Use accounts. See "Enabling Accounts on Content Server".

For details about creating external users, see Administrator's Guide for Oracle WebLogic Server Administration Console Online Help.

4.1.2.2 Local Users

Local users are defined by an administrator within the Content Server system. Administrators assign these users one or more roles, which provide the user with access to security groups.

Caution:
Local users are not supported on Oracle WebLogic Server. Although Content Server administrators can create and configure local users with the User Admin applet, for local users to be authenticated for access to Content Server the users and passwords also must be created on Oracle WebLogic Server. The default user type supported in 11g Release 1 (11.1.1) is External Users.

The following sections focus on local users:

- "Security Groups, Roles, and Permissions"

- "Accounts"

- "User Logins and Aliases"

The following is a list of common characteristics of local users:

- Logins are Created By: Administrator in the Content Server instance.

- Access is Determined By: Content Server roles, which provide access to security groups.

- User Login: Local users cannot log in to the Content Server Admin Server because the Admin Server requires logging in through Oracle WebLogic Server.

- User Password: Users can change their passwords.

- Interface Issues: User names appear in the content check-in lists. Users can specify whether to change full name, e-mail address, and user type.

- Recommended for: 1000 or fewer users. Because of performance considerations, do not configure more than 1000 local users.

Follow these steps to set up local users:

1. Set up security groups. See "Adding a Security Group on Content Server".

2. Establish roles. See "Creating a Role on Content Server".

3. Arrange permissions. See "Adding and Editing Permissions on Content Server".

4. Assign user logins. See "Adding a User Login".

5. (Optional) Use accounts. See "Enabling Accounts on Content Server".

4.1.3 Content Server Security Recommendations

The following is a series of recommendations for improving overall security on a Content Server instance. We recommend using the following types of security to completely secure Content Server:

- Access to the directory structure: Secure the file system to allow access to only those operating system accounts that require access.

- Read Access: Specify Read access for the system administrator to check log files and for those who need to perform regular backups and periodic disaster recovery backups.
Oracle WebLogic Server does not require an external Web server because it has its own Web server. If you are using a configuration with an external Web server, also set Read access for the account that runs the Web server to access and deliver files from the Content Server Web site to the user's browser. The Web site includes the files stored under the /weblayout directory and the /data directory.

- Write Access: Specify Write access for the system administrator to install new software and perform customization. Set Write access for the Content Server and optionally the Inbound Refinery.

There should be no need to grant any other account access to the Content Server directory structure (unless you run some other process to access data directly).

- Network Access: Configure the network to allow access to the Content Server directory structure only through the Content Server application.

The /data directory and the /config directory contain user names and passwords. These directories should not be shared on the network.

For extra security, transmissions to and from the Web server should be encrypted by using Secure Sockets Layer (SSL).

- Database Access: Content Server uses a single database account to access data stored in the database. The database user name and password should be chosen so that they are hard to break and should be updated periodically.

- Physical Access: Keep the server that is running Content Server in a locked room.

4.2 Configuring Security for Oracle UCM and Content Server

This section describes how to configure Oracle UCM and Content Server security to work with Fusion Middleware including Oracle WebLogic Server. Topics include general integration information for Oracle UCM and Content Server deployment, and tasks for setting up specific configurations.

- "Using an LDAP Authentication Provider"

- "Configuring Oracle UCM to Use SSL"

- "Configuring Oracle UCM to Use Single Sign-On"

- "Configuring OID as the First Authentication Provider"

- "Configuring Oracle WebLogic Server Web Services"

- "Additional Security Configuration Documentation"

4.2.1 Using an LDAP Authentication Provider

Oracle WebLogic Server includes an embedded LDAP server that acts as the default security provider data store for the Default Authentication, Authorization, Credential Mapping, and Role Mapping providers. Oracle UCM provides a default JpsUserProvider to communicate with Oracle WebLogic Server. For information on the embedded LDAP server, see "Managing the Embedded LDAP Server" in Oracle Fusion Middleware Securing Oracle WebLogic Server, and "Configure the Embedded LDAP Server" in Oracle WebLogic Server Administration Console Online Help.

If you choose to use an external LDAP provider, you must reassociate the identity store with the external LDAP server rather than use the embedded LDAP server. For information on configuration for an external LDAP provider, see "Reassociating the Identify Store with an External LDAP Authentication Provider" in Installation Guide for Oracle Enterprise Content Management Suite.

4.2.2 Configuring Oracle UCM to Use SSL

You can configure Oracle Fusion Middleware to secure communications between Oracle UCM using SSL, which is an industry standard for securing communications. Oracle Fusion Middleware supports SSL version 3, as well as TLS version 1.

For information, see the related SSL documentation listed in Table 4-1 and the following topics:

- "Configuring Oracle UCM for Two-Way SSL Communication"

- "Invoking References in One-Way SSL Environments in Oracle JDeveloper"

- "Configuring Oracle ECM Suite, Oracle HTTP Server for SSL Communication"

- "Switching from Non-SSL to SSL Configurations with Oracle UCM"

- "Configuring SSL Between Oracle UCM Instances and Oracle WebCache"

- "Using a Custom Trust Store for One-Way SSL During Design Time"

- "Enabling an Asynchronous Process to Invoke Another Asynchronous Process"

- "Configuring RIDC SSL for Valid Certificate Path"

Table 4-1 SSL Documentation

For Information On...

See The Following Guide...

Configuring SSL with Oracle Fusion Middleware: Web Tier, Middle Tier, and Data Tier

Oracle Fusion Middleware Administration Guide: Chapter 6, SSL Configuration in Oracle Fusion Middleware

Configuring SSL with Oracle WebLogic Server

Oracle Fusion Middleware Security Oracle WebLogic Server Guide: Chapter 12, Configuring SSL

4.2.2.1 Configuring Oracle UCM for Two-Way SSL Communication

Oracle ECM Suite uses both the Oracle WebLogic Server and Sun secure socket layer (SSL) stacks for two-way SSL configurations.

- For the inbound Web service bindings, Oracle ECM Suite uses the Oracle WebLogic Server infrastructure and, therefore, the Oracle WebLogic Server libraries for SSL.

- For the outbound Web service bindings, Oracle ECM Suite uses JRF HttpClient and, therefore, the Sun JDK libraries for SSL.

Due to this difference, start Oracle WebLogic Server with the following JVM option.

1. Open the following file:

- On UNIX operating systems, open $MIDDLEWARE_HOME/user_projects/domains/domain_name/bin/setDomainEnv.sh.

- On Window operating systems, open MIDDLEWARE_HOME\user_projects\domains\domain_name\bin\setDomainEnv.bat.

2. Add the following lines in the JAVA_OPTIONS section, if the server is enabled for one-way SSL (server authorization only):

-Djavax.net.ssl.trustStore=your_truststore_location

For two-way SSL, the keystore information (location and password) is not required.

In addition, perform the following steps to enable two-way SSL for Oracle UCM to invoke another application.

Note:
Both the server and client are assumed to have been configured for SSL with mutual authentication.

1. On the client side, provide the keystore location.

1. From the SOA Infrastructure menu, select SOA Administration then Common Properties.

2. At the bottom of the page, click More SOA Infra Advanced Configuration Properties.

3. Click KeystoreLocation.

4. In the Value column, enter the keystore location.

5. Click Apply.

6. Click Return.

2. During design time in Oracle JDeveloper, update the reference section in the composite.xml file with the oracle.soa.two.way.ssl.enabled property.

<reference name="Service1"
ui:wsdlLocation=". . .">
<interface.wsdl interface=". . ."/>
<binding.ws port=". . .">
<property name="oracle.soa.two.way.ssl.enabled">true</property>
</binding.ws>
</reference>

3. In Oracle Enterprise Manager Fusion Middleware Control Console, select WebLogic Domain, then domain_name.

4. Right-click domain_name and select Security then Credentials.

5. Click Create Map.

6. In the Map Name field, enter a name (for example, SOA), and click OK.

7. Click Create Key.

8. Enter the following details.

Field

Description

Select Map

Select the map created in Step 6 (for this example, SOA).

Key

Enter the key name (KeystorePassword is the default).

Type

Select Password.

User Name

Enter the keystore user name (KeystorePassword is the default).

Password

Enter the password that you created for the keystore.

Note:
When you set up SSL in Oracle WebLogic Server, a key alias is required. You must enter mykey as the alias value. This value is required.

9. Set the keystore location in Oracle Enterprise Manager Fusion Middleware Control Console. See Step 1 for instructions.

10. Modify the composite.xml syntax to use https and sslport to invoke Oracle UCM. For example, change the syntax shown in bold:

<?xml version="1.0" encoding="UTF-8" ?>
<!-- Generated by Oracle SOA Modeler version 1.0 at [4/1/09 11:01 PM]. -->
<composite name="InvokeEchoBPELSync"
revision="1.0"
label="2009-04-01_23-01-53_994"
mode="active"
state="on"
xmlns="http://xmlns.oracle.com/sca/1.0"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
xmlns:orawsp="http://schemas.oracle.com/ws/2006/01/policy"
xmlns:ui="http://xmlns.oracle.com/soa/designer/">
<import
namespace="http://xmlns.oracle.com/CustomApps/InvokeEchoBPELSync/BPELProcess1"
location="BPELProcess1.wsdl" importType="wsdl"/>
<import namespace="http://xmlns.oracle.com/CustomApps/EchoBPELSync/
BPELProcess1"location="http://hostname:port/soa-infra/services/default/EchoBPEL
Sync/BPELProcess1.wsdl"
importType="wsdl"/>

to use https and sslport:

location="https://hostname:sslport/soa-infra/services/default/EchoBPELSync
/BPELProcess1.wsdl"

4.2.2.2 Invoking References in One-Way SSL Environments in Oracle JDeveloper

When invoking a Web service as an external reference from Oracle UCM in one-way SSL environments, ensure that the certificate name (CN) and the host name of the server exactly match. This ensures a correct SSL handshake.

For example, if a Web service is named adfbc and the certificate has a server name of myhost05, the following results in an SSL handshake exception.

<import namespace="/adfbc1/common/"

@ location="https://myhost05.us.oracle.com:8002/CustomApps-adfbc1-context-root/Ap
pModuleService?WSDL"
importType="wsdl"/>
<import namespace="/adfbc1/common/" location="Service1.wsdl"
importType="wsdl"/>

If you switch the order of import, the SSL handshake passes.

<import namespace="/adfbc1/common/" location="Service1.wsdl"
importType="wsdl"/>
<import namespace="/adfbc1/common/"

@ location="https://myhost05.us.oracle.com:8002/CustomApps-adfbc1-context-root/Ap
pModuleService?WSDL"
importType="wsdl"/>

Note the following restrictions around this issue:

- There are no options for ignoring host name verification in Oracle JDeveloper as exist with the Oracle WebLogic Server Administration Console. This is because the SSL kit used by Oracle JDeveloper is different. Only the trust store can be configured from the command line. All other certificate arguments are not passed.

- In the WSDL file, https://hostname must match with that in the certificate, as described above. You cannot perform the same procedures as you can with a browser. For example, if the host name is myhost05.us.oracle.com in the certificate's CN, then you can use myhost05, myhost05.us.oracle.com, or the IP address from a browser. In Oracle JDeveloper, always use the same name as in the certificate (that is, myhost05.us.oracle.com).

4.2.2.3 Configuring Oracle ECM Suite, Oracle HTTP Server for SSL Communication

Follow these procedures to configure SSL communication between Oracle ECM Suite and Oracle HTTP Server.

Configure Oracle HTTP Server for SSL Communication

1. Update mod_ssl.conf with the <Location /integration/services> location directive.

LoadModule weblogic_module   ${ORACLE_HOME}/ohs/modules/mod_wl_ohs.so

<IfModule mod_weblogic.c>
WebLogicHost host.domain.com
WLLogFile <logdir>/ohs_ssl.log
Debug ALL
DebugConfigInfo ON
SecureProxy ON
MatchExpression *.jsp
WlSSLWallet <OHS_
HOME>/instances/instance1/config/OHS/ohs1/keystores/default
</IfModule>

<Location /soa-infra>
WebLogicPort 8002
SetHandler weblogic-handler
ErrorPage http://host.domain.com:port/error.html
</Location>

<Location /b2bconsole>
WebLogicPort 8002
SetHandler weblogic-handler
ErrorPage http://host.domain.com:port/error.html
</Location>

<Location /b2b>
WebLogicPort 8002
SetHandler weblogic-handler
ErrorPage http://host.domain.com:port/error.html
</Location>

<Location /integration/worklistapp>
WebLogicPort 8002
SetHandler weblogic-handler
ErrorPage http://host.domain.com:port/error.html
</Location>

<Location /integration/services>
WebLogicPort 8002
SetHandler weblogic-handler
ErrorPage http://host.domain.com:port/error.html
</Location>

<Location /DefaultToDoTaskFlow>
WebLogicPort 8002
SetHandler weblogic-handler
ErrorPage http://host.domain.com:port/error.html
</Location>

<Location /OracleBAM>
WebLogicPort 9002
SetHandler weblogic-handler
ErrorPage http://host.domain.com:port/error.html
</Location>

<Location /OracleBAMWS>
>       WebLogicPort 9002
>       SetHandler weblogic-handler
>       ErrorPage  http://host.domain.com:port/error.html
> </Location>

<Location /sdpmessaging/userprefs-ui/>
WebLogicPort 8002
SetHandler weblogic-handler
ErrorPage http://host.domain.com:port/error.html
</Location>

2. Start the Oracle WebLogic Servers as described in "Configuring Oracle UCM for Two-Way SSL Communication"

Configure Certificates for Oracle Client, Oracle HTTP Server, and Oracle WebLogic Server

1. Export the user certificate from the Oracle HTTP Server wallet.

orapki wallet export -wallet . -cert cert.txt  -dn 'CN=\"Self-Signed Certificate for ohs1 \",OU=OAS,O=ORACLE,L=REDWOODSHORES,ST=CA,C=US'

2. Import the above certificate into the Oracle WebLogic Server truststore as a trusted certificate.

keytool -file cert.txt -importcert -trustcacerts -keystore DemoTrust.jks

3. Export the certificate from the Oracle WebLogic Server truststore.

keytool -keystore DemoTrust.jks -exportcert -alias wlscertgencab -rfc -file
certgencab.crt

4. Import the above certificate to the Oracle HTTP Server wallet as a trusted certificate.

orapki wallet add -wallet . -trusted_cert -cert certgencab.crt -auto_login_only

5. Restart Oracle HTTP Server.

6. Restart the Oracle WebLogic Servers as described in "Configuring Oracle UCM for Two-Way SSL Communication"

4.2.2.4 Switching from Non-SSL to SSL Configurations with Oracle UCM

Switching from non-SSL to SSL configurations with Oracle UCM requires the Frontend Host and Frontend HTTPS Port fields to be set in the Oracle WebLogic Server Administration Console. Not doing so results in exception errors when you attempt to create to-do tasks.

1. Log in to Oracle WebLogic Server Administration Console.

2. In the Environment section, select Servers.

3. Select the name of the managed server (for example, ucm_server1).

4. Select Protocols, then select HTTP.

5. In the Frontend Host field, enter the host name on which Oracle UCM is located.

6. In the Frontend HTTPS Port field, enter the SSL listener port.

7. Click Save.

4.2.2.5 Configuring SSL Between Oracle UCM Instances and Oracle WebCache

The Test Web Service page, in an Oracle WebCache and Oracle HTTP Server environment, may require communication back through Oracle WebCache. Therefore, SSL must be configured between the Oracle UCM instance and Oracle WebCache (that is, export the user certificate from the Oracle WebCache wallet and import it as a trusted certificate in the Oracle WebLogic Server truststore).

4.2.2.6 Using a Custom Trust Store for One-Way SSL During Design Time

To invoke Oracle UCM over HTTPS when using a custom trust store created with a tool such as keytool or orapki, perform the following actions in Oracle JDeveloper.

1. To fetch a WSDL file in the reference section, set the trust store information in Tools, then Preferences, then Http Analyzer, then HTTPS Setup, then Client Trusted Certificate Keystore.

2. During deployment to an SSL-enabled server, use the JSSE property at the command line:

jdev -J-Djavax.net.ssl.trustStore=your_trusted_location

4.2.2.7 Enabling an Asynchronous Process to Invoke Another Asynchronous Process

To enable an asynchronous process deployed to an SSL-enabled, managed server to invoke another asynchronous process over HTTP, start by assuming you create the following environment:

- Asynchronous BPEL process A that invokes asynchronous BPEL process B

- Asynchronous BPEL process A is deployed to a one-way SSL enabled, managed server

- All WSDL reference and bindings use plain HTTP

At run time, the WSDL is looked for over HTTPS, and the callback message from asynchronous BPEL process B fails.

To resolve this issue, the callbackServerURL property must be passed at the reference binding level in the composite.xml file. This explicitly indicates the value of the callback URL for the given reference invocation. If the client composite is running in an SSL-managed server, then the callback defaults to SSL.

<reference name="Service1"
ui:wsdlLocation="http://localhost:8000/soa-infra/services/default/AsyncSecondB
PELMTOM/BPELProcess1.wsdl">
<interface.wsdl
interface="http://xmlns.oracle.com/Async/AsyncSecondBPELMTOM/BPELProcess1#wsdl
.interface(BPELProcess1)"
callbackInterface="http://xmlns.oracle.com/Async/AsyncSecondBPELMTOM/BPELProce
ss1#wsdl.interface(BPELProcess1Callback)"/>
<binding.ws
port="http://xmlns.oracle.com/Async/AsyncSecondBPELMTOM/BPELProcess1#wsdl.endp
oint(bpelprocess1_client_ep/BPELProcess1_pt)"

location="http://localhost:8000/soa-infra/services/default/AsyncSecondBPELMTOM
/bpelprocess1_client_ep?WSDL">
<wsp:PolicyReference URI="oracle/wss_username_token_client_policy"
orawsp:category="security"
orawsp:status="enabled"/>
<wsp:PolicyReference URI="oracle/wsaddr_policy"
orawsp:category="addressing"
orawsp:status="enabled"/>
.
<property name="callbackServerURL">http://localhost:8000/</property>
.
</binding.ws>
.
<callback>
<binding.ws
port="http://xmlns.oracle.com/Async/AsyncSecondBPELMTOM/BPELProcess1#wsdl.endp
oint(bpelprocess1_client_ep/BPELProcess1Callback_pt)">
<wsp:PolicyReference
URI="oracle/wss_username_token_service_policy"
orawsp:category="security"
orawsp:status="enabled"/>
</binding.ws>
</callback>

.
</reference>

4.2.2.8 Configuring RIDC SSL for Valid Certificate Path

To use Remote Intradoc Client (RIDC) and self-signed certificates, you must import the certificate into your local JVM certificate store so the certificate will be trusted.

1. Retrieve the key from the Content Server. For example:

openssl s_client -connect dadvmc0022.us.company.com:7045 2>/dev/null

CONNECTED(00000003)---Certificate chain 0 s:/C=US/ST=MyState/L=MyTown/O=MyOrganization/OU=FOR TESTING ONLY/CN=dadvmc0022   i:/C=US/ST=MyState/L=MyTown/O=MyOrganization/OU=FOR TESTING ONLY/CN=CertGenCAB---Server certificate-----BEGIN CERTIFICATE-----MIIB6zCCAZUCEItVMwHDFXAnYG//RoVbXQgwDQYJKoZIhvcNAQEEBQAweTELMAkGA1UEBhMCVVMxEDAOBgNVBAgTB015U3RhdGUxDzANBgNVBAcTBk15VG93bjEXMBUGA1UEChMOTXlPcmdhbml6YXRpb24xGTAXBgNVBAsTEEZPUiBURVNUSU5HIE9OTFkxEzARBgNVBAMTCkNlcnRHZW5DQUIwHhcNMDkwMzI5MjM0NDM0WhcNMjQwMzMwMjM0NDM0WjB5MQswCQYDVQQGEwJVUzEQMA4GA1UECBYHTXlTdGF0ZTEPMA0GA1UEBxYGTXlUb3duMRcwFQYDVQQKFg5NeU9yZ2FuaXphdGlvbjEZMBcGA1UECxYQRk9SIFRFU1RJTkcgT05MWTETMBEGA1UEAxYKZGFkdm1jMDAyMjBcMA0GCSqGSIb3DQEBAQUAA0sAMEgCQQCmxv+h8kzOc2xyjMCdPM6By5LY0Vlp4vzWFKmPgEytp6Wd87sG+YDBPeFOz210XXGMx6F/14/yFlpCplmazWkDAgMBAAEwDQYJKoZIhvcNAQEEBQADQQBnuF/s6EqCT38Aw7h/406uPhNh6LUF7XH7QzmRv3J1sCxqRnA/fK3JCXElshVlPk8GhwE4G1zxpr/JZu6+jLrW-----END CERTIFICATE-----subject=/C=US/ST=MyState/L=MyTown/O=MyOrganization/OU=FOR TESTING ONLY/CN=dadvmc0022issuer=/C=US/ST=MyState/L=MyTown/O=MyOrganization/OU=FOR TESTING ONLY/CN=CertGenCAB---No client certificate CA names sent---SSL handshake has read 625 bytes and written 236 bytes---New, TLSv1/SSLv3, Cipher is RC4-MD5Server public key is 512 bitCompression: NONEExpansion: NONE
SSL-Session:   Protocol  : TLSv1   Cipher    : RC4-MD5   Session-ID: 23E20BCAA4BC780CE20DE198CE2DFEE4   Session-ID-ctx:    Master-Key: 4C6F8E9B9566C2BAF49A4FD91BE90DC51F1E43A238B03EE9B700741AC7F4B41C72D2990648DE103BB73B3074888E1D91   Key-Arg   : None   Start Time: 1238539378   Timeout   : 300 (sec)   Verify return code: 21 (unable to verify the first certificate)---

2. Copy and paste the Server Certificate including the surrounding -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- lines. Save the certificate into a new file. For example:

/tmp/dadvmc0022.pem:

-----BEGIN CERTIFICATE-----
MIIB6zCCAZUCEItVMwHDFXAnYG//RoVbXQgwDQYJKoZIhvcNAQEEBQAweTELMAkG
A1UEBhMCVVMxEDAOBgNVBAgTB015U3RhdGUxDzANBgNVBAcTBk15VG93bjEXMBUG
A1UEChMOTXlPcmdhbml6YXRpb24xGTAXBgNVBAsTEEZPUiBURVNUSU5HIE9OTFkx
EzARBgNVBAMTCkNlcnRHZW5DQUIwHhcNMDkwMzI5MjM0NDM0WhcNMjQwMzMwMjM0
NDM0WjB5MQswCQYDVQQGEwJVUzEQMA4GA1UECBYHTXlTdGF0ZTEPMA0GA1UEBxYG
TXlUb3duMRcwFQYDVQQKFg5NeU9yZ2FuaXphdGlvbjEZMBcGA1UECxYQRk9SIFRF
U1RJTkcgT05MWTETMBEGA1UEAxYKZGFkdm1jMDAyMjBcMA0GCSqGSIb3DQEBAQUA
A0sAMEgCQQCmxv+h8kzOc2xyjMCdPM6By5LY0Vlp4vzWFKmPgEytp6Wd87sG+YDB
PeFOz210XXGMx6F/14/yFlpCplmazWkDAgMBAAEwDQYJKoZIhvcNAQEEBQADQQBn
uF/s6EqCT38Aw7h/406uPhNh6LUF7XH7QzmRv3J1sCxqRnA/fK3JCXElshVlPk8G
hwE4G1zxpr/JZu6+jLrW
-----END CERTIFICATE-----

3. Import the certificate into the local JVM certificate store. You will need the keystore password. For example (the password is changeit):

sudo /opt/java/jdk1.6.0_12/bin/keytool -import -alias dadvmc0022 -keystore /opt/java/jdk1.6.0_12/jre/lib/security/cacerts -trustcacerts -file /tmp/dadvmc0022.pem

Enter keystore password: changeit Owner: CN=dadvmc0022, OU=FOR TESTING ONLY, O=MyOrganization, L=MyTown, ST=MyState, C=USIssuer: CN=CertGenCAB, OU=FOR TESTING ONLY, O=MyOrganization, L=MyTown, ST=MyState, C=USSerial number: -74aaccfe3cea8fd89f9000b97aa4a2f8Valid from: Sun Mar 29 16:44:34 PDT 2009 until: Sat Mar 30 16:44:34 PDT 2024Certificate fingerprints:       MD5:  94:F9:D2:45:7F:0D:E3:87:CF:2B:32:7C:BF:97:FF:50   SHA1: A8:A5:89:8B:48:9B:98:34:70:56:11:01:5C:14:32:AC:CB:18:FF:1F       Signature algorithm name: MD5withRSA    Version: 1Trust this certificate? [no]:  yesCertificate was added to keystore

4.2.3 Configuring Oracle UCM to Use Single Sign-On

Oracle Access Manager (OAM), part of Oracle's suite of enterprise class products for identity management and security, provides a wide range of identity administration and security functions, including several single sign-on (SSO) options for Fusion Middleware and custom Fusion Middleware applications. OAM is the recommended single sign-on solution for Oracle Fusion Middleware 11g enterprise-class installations.

If your enterprise uses Microsoft desktop logins that authenticate with a Microsoft domain controller with user accounts in Active Directory, then configuring SSO with Microsoft Clients may be an option.

Basic setup required for these SSO solutions is described in the documents listed in Table 4-2. Specific setup required for Oracle UCM, Content Server, and SSO solutions is described in the following sections:

- "Configuring Oracle Access Manager (OAM)"

- "Configuring Oracle Single Sign-On for Oracle UCM"

- "Configuring SSO with Microsoft Clients"

Table 4-2 Single Sign-on Documentation

For Information On...

See The Following Guide...

Configuring OAM

Oracle Fusion Middleware Security Guide: Chapter 10, Configuring Single Sign-On in Oracle Fusion Middleware

Configuring OSSO

Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Identity Management

Using Windows Native Authentication for Single Sign-on

Oracle WebLogic Server Admin Console Help: Configure Authentication and Identify Assertion Providers

4.2.3.1 Configuring Oracle Access Manager (OAM)

Oracle Access Manager provides flexible and extensible authentication and authorization, and provides audit services. This section provides the minimum requirements to configure OAM as a single sign-on (SSO) authentication provider and describes how to configure Oracle WebLogic Server and the Content Server application as the partner application participating in SSO.

- "Concepts and Topology"

- "Oracle WebLogic Server and Oracle UCM"

- "Oracle Internet Directory"

- "Install and Configure Oracle HTTP Server (OHS)"

- "Create an AccessGate Object on OAM Access Server"

- "Install a WebGate Client on Your OHS"

- "Create a Domain Policy in OAM"

- "Configure Oracle UCM Domain for OAM"

4.2.3.1.1 Concepts and Topology

The following concepts are important to configuring OAM:

- Access Server: A standalone server that provides authentication, authorization, and auditing services for AccessGates. There is one Access Server set up on OAM, which is done as part of the OAM install itself.

- WebGate: An out-of-the-box plug-in that intercepts Web resource (HTTP) requests and forwards them to the Access Server for authentication and authorization.

- Identity Assertion Provider (IAP): A type of authenticator that asserts the identity of the user based on some header information that is set by perimeter authentication. The OAM integration provides an OAMAuthenticator that can be configured as the OAM IAP. The OAMAuthenticator can be used for authentication or for identity assertion. For OAM SSO integration, the OAMAuthenticator should be configured as an Identity Assertion Provider (IAP), by specifying the obSSOCookie under Active Types in the provider's general settings.

- Content Server: Content management server also referred to as ECM, UCM, or CS.

Figure 4-1 shows the topology involved in setting up Content Server deployed on an Oracle WebLogic Server with OAM for single sign-on.

Figure 4-1 Oracle Access Manager Single Sign-On Topology

4.2.3.1.2 Oracle WebLogic Server and Oracle UCM

Ensure that Oracle WebLogic Server is installed and Oracle UCM is deployed. For information, see Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite.

4.2.3.1.3 Oracle Internet Directory

Ensure that Oracle Internet Directory (OID) 11g is installed and configured. For information about installation, see Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite. For information about administration, see Oracle Fusion Middleware Administrator's Guide for Oracle Internet Directory.

4.2.3.1.4 Install and Configure Oracle HTTP Server (OHS)

Install and configure the WebTier, which contains Oracle WebCache and Oracle HTTP Server (OHS). Oracle Access Manager requires OHS. Oracle WebCache may be installed, although Oracle Access Manager does not require it.

When you link OHS to the Oracle WebLogic Server where Oracle UCM and Content Server are deployed, the default listening port of OHS is 7777.

Configure mod_weblogic (mod_wl_ohs.conf)

After you install OHS, append the following entries to the files in the module mod_wl_ohs in the WebTier OHS, so that the module forwards requests to the Oracle WebLogic Server for Content Server. In the following entries, <ucm-hostname> represents the hostname of the machine hosting Oracle UCM, and <ucm-server-port> represents the port of the Oracle WebLogic Server hosting Oracle UCM.

<Location /cs>
SetHandler weblogic-handler
WebLogicHost <ucm-hostname>
WebLogicPort <ucm-server-port>
</Location>

4.2.3.1.5 Create an AccessGate Object on OAM Access Server

Before WebGate installation, an AccessGate object must be created in the Access Admin Console and associated with an Access Server.

Note:
The Oracle Access Manager Configuration tool (OAM Configuration tool) is a command line utility that enables you to configure OAM. The OAM Configuration tool runs a series of scripts and sets up the required policies. You have the option to use this tool instead of the following procedure to configure an AccessGate object. For details, see Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Identity Management.

The following procedure assumes you have access to an existing OAM Access Server.

1. In the OAM Access Server, click the Access System Console link.

2. Click the Access System Configuration tab and then click the Host Identifier link.

3. Add a new host identifier similar to the following examples:
Name: your_host_machine.company.com
Hostname variations: your_host_machine.company.com:7777
your_host_machine.company.com:16200
your_host_machine.company.com:8888

4. Click the Add New Access Gate link.

5. Enter the following values, and keep defaults for the non-specified values:

Element

Description

AccessGate Name

Pick a unique name (for example, ohs11gwg_sta00834_7777)

Description

Webgate for hostname WLS-ECM-OAM integration

Hostname

your_host_machine .company.com

Port

7777 (Port number that OHS is listening on)

Access Gate Password

welcome1 (or password for your system)

Failover Threshhold

1

Impersonation username

your choice (for example, wlscs)

Impersonation password

welcome1 (or password for your system0

Access Management Service

On

Primary HTTP Cookie Domain

.company.com

Preferred HTTP Host

your_host_machine.company.com

6. Add the Access Server to the newly created Access Gate.

4.2.3.1.6 Install a WebGate Client on Your OHS

Before you start the installation, run the following commands as root in a shell window:

cd /tmp   mkdir bin.$$   cd bin.$$   cat > mount <<EOF   #! /bin/sh   exec /bin/true   EOF   chmod 755 mount
export PATH=`pwd`:$PATH

The Webgate requires the following libraries prior to installation: libgcc_s.so.1 and libstdc++.so.5. The files must be installed in a local directory (for example: /root/username/gcc). Change the access mode of the copied files to full access: chmod 777 *. This local directory is specified later during the installation of the WebGate.

Run the OAM Webgate 10.1.4.3.0 installer as root (./Oracle_Access_Manager10_1_4_3_0_linux_OHS11g_WebGate) and follow the prompts:

1. Specify the user/group running webserver.

2. Specify the installation directory for Oracle Access Manager 10.1.4.3.0 Webgate (for example: /root/username/webgate). Note that the OAM 10.1.4.3.0 Webgate installation directory would be: /root/username/webgate/access.

3. For "Location of GCC runtime libraries", specify the directory where you installed libgcc_s.so.1 and libstdc++.so.5.

4. For "transport security mode'', select Open mode.

5. For "Webgate ID", enter the AccessGate Name you specified in Create an AccessGate Object on OAM Access Server.

6. For "Access Server ID" enter the name listed in the hosted Oracle Access Manager's Access System Configuration > Access Server Configuration > Details for Access Server screen.

7. For "Hostname where Access Server is installed", enter the host name where OAM Access Server is running.

8. For "Port number", enter the port for the hosted OAM server's Access Server ID.

9. Select Automatic update of httpd.conf.

10. For "Enter the absolute path of httpd.conf in your Web server config directory", enter the OHS instance path. For example: /root/username/ohs/instances/instance1/config/OHS/ohs1/httpd.conf

11. For '"Please restart your WebServer to complete the installation of WebGate", follow these steps:

1. Open a new session as root.

2. Go to the bin directory of your OHS instance (for example: /root/username/ohs/instances/instance1/bin).

3. Run opmnctl stopall.

4. Run opmnctl startall.

When the installer is finished running, you can run the following command to clean the temporary directory: rm -r /tmp/bin.$$

The installation of WebGate provides a login page.

4.2.3.1.7 Create a Domain Policy in OAM

Follow the steps below to create a Domain Policy in the OAM Access Server:

Note:
The Oracle Access Manager Configuration tool (OAM Configuration tool) is a command line utility you can use to configure OAM. The OAM Configuration tool runs a series of scripts and sets up the required policies. You have the option to use this tool instead of the following procedure to configure a Domain Policy in OAM. For details, see Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Identity Management.

1. Access the Oracle Access Manager admin page, then click the Policy Manager link, and click the Create Policy Domain link.

2. Give the Policy Domain a name and description. For example:
Name: OAM WLS-CS Policy Domain Description: OAM WLS-CS Policy Domain

3. Click Resources, then Add, and specify values for the following settings:
Host Identifier: your_hosted_machine.company.comURL Prefix: /cs/idcplg

4. Click Resources, then Add, and specify values for the following settings:
Host Identifier: your_hosted_machine.company.comURL Prefix: /cs/groups

5. Click Authorization Rules, then Add.

6. On the General tab, specify values for the following settings:
Name: Name of your choice (for example: OAM WLS-CS Authz rule). Description: Authorization rule for allowing access to anyone. This rule provides anyone access to Oracle WebLogic Server applications. Enabled: Yes

7. Click Default Rule and specify values for the following settings:
Name: Name of your choice (for example: WLS-CS SSO Login) Description: Authentication rule for Form based Login. Authentication Scheme: Form Authentication scheme_PSL-QA Authorization Expression: Select OAM WLS-CS Authz Rule (specified in step 5).

8. Click Save.

9. For Creating Policy for Domain (Policies tab), create the following General Policy:
Name: Name of your choice (for example: WLS-CS Protection Policy). Description: Protected resources in WLS-CS that should require authentication. Resource Type: http Resource Operation(s): GET, POST, PUT Resource: all Host Identifiers: your_hosted+machine.compan.com

10. Add header variables to the authorization expression action. Select Policy Domains, then Default Rules, then Authorization Expression, then Actions, then Authorization Failure.
Return Type: Name: Return Attribute: WL_REALM obmygroups obmygroups WL_REALM uid uid

4.2.3.1.8 Configure Oracle UCM Domain for OAM

When configuring the Oracle Universal Content Management (UCM) domain for Oracle Access Manager (OAM), there are several authenticators to be configured:

- OAMAuthenticator (OAM authenticator configured for Identity Assertion mode to support SSO). The OAMAuthenticator must be configured to complete the support for Oracle Access Manager.

- OracleInternetDirectoryAuthenticator (assuming Oracle Internet Directory is backing the OAM identity store). This authenticator must be configured for the LDAP server that is used as the identity store for OAM.

- DefaultAuthenticator. This is the default authenticator.

Backing Up Files

Before configure the authenticators, be sure to back up the boot.properties file for the Oracle WebLogic Server Admin Server, and back up the relevant configuration files:

- /config/config.xml

- /config/fmwconfig/jps_config.xml

- /config/fmwconfig/system-jazn-data.xml

Configuring the Identity Store

To configure the identity store to use LDAP, set the proper authenticator using the Oracle WebLogic Server Administration Console:

1. Log in to the Oracle WebLogic Server Administration Console.

2. Click the Security Realms link on the side navigation bar.

3. Click the myrealm default realm entry to configue it.

4. Click the Providers tab within the realm.
Note that there is a DefaultAuthenticator provider configured for the realm.

5. Click New to create a new Authentication provider.

6. Enter a name for the provider, such as "OIDAuthenticator" for a provider that will authenticate the user to the Oracle Internet Directory.

7. Select the OracleInternetDirectoryAuthenticator type from the list of authenticators.

8. Click OK.

9. In the Providers screen, click the newly created OIDAuthenticator.

10. Set the control flag to SUFFICIENT. This flag indicates that if a user can be authenticated successfully by this authenticator, then the authentication should be accepted and no additional authenticators are invoked. If the authentication fails, it will fail through to the next authenticator in the chain.
Make sure that all subsequent authenticators also have their control flag set to SUFFICIENT. In particular, check that the DefaultAuthenticator is set to SUFFICIENT.

11. Click Save.

12. Click the Provider Specific tab.

13. Enter the details specific to your LDAP server.

14. Click Save when you have entered all the detail for the LDAP server.

Configuring the OAM ID Asserter

To set up the OAM ID Asserter, complete these steps:

1. Log in to the Oracle WebLogic Server Administration Console.

2. Click the Security Realms link on the side navigation bar.

3. Click the myrealm default realm entry to configure it.

4. Click the Providers tab within the realm.

5. Click New and select OAM Identity Asserter from the menu.

6. Click the newly added asserter to see the configuration screen for OAM Identity Asserter.

7. Set the control flag to REQUIRED.

8. Click Save.

9. Open the Provider Specific tab to configure the following required settings.

- Primary Access Server: provide OAM server endpoint information in HOST:PORT format.

- Access Gate Name: name of the access gate (for example, WebCenter_EDG_AG).

- Access Gate Password: password for the access gate (optional).

10. Click Save.

Setting the Order of Providers

Re-order the OAM Identity Asserter, OID Authenticator, and Default Authenticator by ensuring that the control flag for each authenticator is set as follows:

- OAMAuthenticator (REQUIRED)

- OracleInternetDirectoryAuthenticator (SUFFICIENT)

- DefaultAuthenticator (SUFFICIENT)

Configuring Oracle UCM for Global SSO Logout

Configure a system property to integrate Oracle UCM with global Single Sign-On (SSO) to support acquiring the correct URL for logging out of the system. Edit the DOMAIN_HOME/ucm/short-product-id/config/config.cfg file and append the following entry:

LogoutServerUrl=/oamsso/logout.html?end_url=<$HttpBrowserFullWebRoot$>

Note:
if this file does not exist, start the Oracle UCM managed server and access the Oracle UCM application, then restart the server.

4.2.3.2 Configuring Oracle Single Sign-On for Oracle UCM

To configure Oracle Single Sign-On (OSSO) for Oracle Universal Content Management (UCM), follow this procedure:

1. Install Oracle UCM.

2. Install Oracle Single Sign-On.

3. Start the Oracle WebLogic Server Admin server and navigate the Domain Structure to Security Realms, then myrealm.

4. Select myrealm from the Summary of Security Realms.

5. Select the Providers tab in the Settings for myrealm, then click New in the Authentication Providers list.

6. Select OSSOIdentityAsserter from the menu, then enter the name for the provider (for example, "MyAssertionProvider")

7. Click OK.

8. Return to the Providers tab in the Settings for myrealm screen, and select the provider you named (in this example, "MyAssertionProvider"). Change the control flag to REQUIRED.

9. Follow the instructions in "Configure Oracle UCM Domain for OAM".

10. Edit the mod_wl_ohs.conf file in OHS so the locations point to Oracle WebLogic Server:

LoadModule weblogic_module ${ORACLE_HOME}/ohs/modules/mod_wl_ohs.so

<ifModule mod_weblogic.c>
Debug ON
WLLogFile /tmp/weblogic.log
MatchExpression

<Location /cs>
WebLogicHost wlshost.company.com
WebLogicPort port-number
SetHandler weblogic_handler
</Location>
</IfModule>

11. Register the OHS in OSSO. Go to ORACLE_HOME/sso/bin and run ssoreg.sh.

./ssoreg.sh -oracle_home_path
<path_to_10.1.4 SSO_Oracle_Home> -site_name <any_site_name>
-config_mod_osso TRUE - mod_osso_url
<front-ending-OHSSHost:port> -
update_mode CREATE -remote_midtier -
config_file <path_where_osso.conf_will_get_generated>

For example:

./ssoreg.sh _oracle_home_path
/root/<domain>/OraHome -site_name wls_server
-config_mod_osso TRUE -mod_osso_url
http://<domain>.<company-name>.<suffix>:7777 -
update_mode CREATE -remote_midtier -
config_file /tmp/osso.conf

12. Edit the file mod_osso.conf (at ORACLE_HOME/ohs/conf/) to include the following code:

LoadModule osso_module modules/mod_osso.so
<IfModule mod_osso.c>

OssoIdletimeout off
OssoIpCheck on
OssoConfigFile /tmp/osso.conf

<IfModule mod_osso.c>
OssoIpCheck off
OssoIdleTimeout off
OssoSecureCookies off
OssoConfigFile
/root/username/Oracle/ECM_version/osso.conf

<Location /cs/groups>
require valid-user
AuthType Osso
</Location>

<Location /cs/idcplg>
require valid-user
AuthType Osso
</Location>
</IfModule>

For the two Location settings in the code, as appropriate replace /cs/ with /ibr/ for Inbound Refinery, or /urm/ for Universal Records Management.

4.2.3.3 Configuring SSO with Microsoft Clients

Configuring Single Sign-On (SSO) with Microsoft clients requires configuring the Microsoft Active Directory, the client, and the Oracle WebLogic Server domain as described in the section “Configuring Single Sign-On with Microsoft Clients” in Oracle Fusion Middleware Security Oracle WebLogic Server.

In addition to that configuration, you must redeploy each Oracle UCM application (Content Server, Inbound Refinery, or Universal Records Management) that will be used in the Windows Native Authentication (WNA) environment, using an associated deployment plan. A deployment plan is an XML document, which Oracle provides for each of the three Oracle UCM applications. The plans are listed in the sections: Plan-cs.xml, Plan-ibr.xml, and Plan-urm.xml. You also can implement a deployment plan using the Oracle WebLogic Scripting Tool.

To redeploy Oracle UCM for a WNA environment:

1. Log in to the Oracle WebLogic Server Administration Console.

2. Click Deployments in the Domain Structure navigation tree.

3. On the Control tab, click Next until you see the Oracle UCM deployment you want to change:

- Oracle Universal Content Management - Content Server

- Oracle Universal Content Management - Inbound Refinery

- Oracle Universal Records Management

4. Select the check box to the left of the deployment to be changed.

5. Click Update.

6. Under the Deployment plan path, select Change Path.

7. Navigate to and select the appropriate plan file:

- plan-cs.xml (for Content Server)

- plan-ibr.xml (for Inbound Refinery)

- plan-urm.xml (for Universal Records Management)

8. Verify that Redeploy this application using the following deployment files is selected.

9. Click Next.

10. Click Finish.

Plan-cs.xml

Use the provided plan-cs.xml file, or create an .xml file and name it plan-cs.xml.

<?xml version='1.0' encoding='UTF-8'?>
<deployment-plan
xmlns="http://xmlns.oracle.com/weblogic/deployment-plan"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.oracle.com/weblogic/deployment-plan http://xmlns.oracle.com/weblogic/deployment-plan/1.0/deployment-plan.xsd"
global-variables="false">
<application-name>cs.ear</application-name>
<variable-definition>
<variable>
<name>url-pattern</name>
<value>/*</value>
</variable>
<variable>
<name>http-only</name>
<value>false</value>
</variable>
</variable-definition>
<module-override>
<module-name>cs.war</module-name>
<module-type>war</module-type>
<module-descriptor external="false">
<root-element>web-app</root-element>
<uri>WEB-INF/web.xml</uri>
<variable-assignment>
<name>url-pattern</name>     <xpath>/web-app/security-constraint/[display-name="UCMConstraint"]/web-resource-collection/[web-
resource-name="idcauth"]/url-pattern</xpath>
<operation>replace</operation>
</variable-assignment>
</module-descriptor>
<module-descriptor external="false">
<root-element>weblogic-web-app</root-element>
<uri>WEB-INF/weblogic.xml</uri>
<variable-assignment>
<name>http-only</name>
<xpath>/weblogic-web-app/session-descriptor/cookie-http-only</xpath>
</variable-assignment>
</module-descriptor>
</module-override>
</deployment-plan>

Plan-ibr.xml

Use the provided plan-ibr.xml file, or create an .xml file and name it plan-ibr.xml.

<?xml version='1.0' encoding='UTF-8'?>
<deployment-plan xmlns="http://xmlns.oracle.com/weblogic/deployment-plan" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "http://xmlns.oracle.com/weblogic/deployment-plan http://xmlns.oracle.com/weblogic/deployment-plan/1.0/deployment-plan.xsd" global-variables="false">
<application-name>ibr.ear</application-name>
<variable-definition>
<variable>
<name>url-pattern</name>
<value>/*</value>
</variable>
<variable>
<name>http-only</name>
<value>false</value>
</variable>
</variable-definition>
<module-override>
<module-name>ibr.war</module-name>
<module-type>war</module-type>
<module-descriptor external="false">
<root-element>web-app</root-element>
<uri>WEB-INF/web.xml</uri>
<variable-assignment>
<name>url-pattern</name>
<xpath>/web-app/security-constraint/[display-name="UCMConstraint"]/web-resource-collection/[web-
resource-name="idcauth"]/url-pattern</xpath>
<operation>replace</operation>
</variable-assignment>
</module-descriptor>
<module-descriptor external="false">
<root-element>weblogic-web-app</root-element>
<uri>WEB-INF/weblogic.xml</uri>
<variable-assignment>
<name>http-only</name>
<xpath>/weblogic-web-app/session-descriptor/cookie-http-only</xpath>
</variable-assignment>
</module-descriptor>
</module-override>
</deployment-plan>

Plan-urm.xml

Use the provided plan-urm.xml file, or create an .xml file and name it plan-urm.xml.

<?xml version='1.0' encoding='UTF-8'?>
<deployment-plan
xmlns="http://xmlns.oracle.com/weblogic/deployment-plan"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.oracle.com/weblogic/deployment-plan http://xmlns.oracle.com/weblogic/deployment-plan/1.0/deployment-plan.xsd"
global-variables="false">
<application-name>urm.ear</application-name>
<variable-definition>
<variable>
<name>url-pattern</name>
<value>/*</value>
</variable>
<variable>
<name>http-only</name>
<value>false</value>
</variable>
</variable-definition>
<module-override>
<module-name>urm.war</module-name>
<module-type>war</module-type>
<module-descriptor external="false">
<root-element>web-app</root-element>
<uri>WEB-INF/web.xml</uri>
<variable-assignment>
<name>url-pattern</name>
<xpath>/web-app/security-constraint/[display-name="UCMConstraint"]/web-resource-collection/[web-
resource-name="idcauth"]/url-pattern</xpath>
<operation>replace</operation>
</variable-assignment>
</module-descriptor>
<module-descriptor external="false">
<root-element>weblogic-web-app</root-element>
<uri>WEB-INF/weblogic.xml</uri>
<variable-assignment>
<xpath>/weblogic-web-app/session-descriptor/cookie-http-only</xpath>
</variable-assignment>
</module-descriptor>
</module-override>
</deployment-plan>

4.2.4 Configuring OID as the First Authentication Provider

Oracle Internet Directory (OID) stores user and group information for enterprise platforms. When Oracle WebLogic Server is configured to use OID instead of its embedded LDAP server for user authentication, the OID Authentication provider must be the first provider listed in the security realm configuration.

If the OID Authentication provider is not listed first (for example, it is listed below the Oracle WebLogic Server provider, DefaultAuthenticator), then Oracle UCM will fail to successfully load the users' Group membership and therefore fail to load any of the users' privileges. You can use the Oracle WebLogic Server Administration Console to change the order in which the configured Authentication providers are called.

When you use OID, all Oracle UCM administrator and other users must be defined in OID.

Note:
Content Server assigns a Content Server administrator role to administrative users defined in the internal Oracle WebLogic Server user store. This is true regardless of whether Oracle Internet Directory is used or not used. However, if you use Oracle Internet Directory and the Oracle Internet Directory Authentication provider is not listed first, then any request by the Content Server to retrieve the roles of the Oracle WebLogic Server defined administrative users will fail.

For information about changing the order of authentication providers, see Oracle Fusion Middleware Securing Oracle WebLogic Server.

4.2.5 Configuring Oracle WebLogic Server Web Services

Oracle WebLogic Server Web Services are implemented according to the Web Services for Java EE 1.2 specification, which defines the standard Java EE runtime architecture for implementing Web Services in Java. The specification also describes a standard Java EE Web Service packaging format, deployment model, and runtime services, all of which are implemented by Oracle WebLogic Server Web Services. For information, see the documentation listed in Table 4-3.

Table 4-3 Web Services Documentation

For Information On...

See The Following Guide...

Apply OWSM security to Web Services

Oracle Fusion Middleware Securing WebLogic Web Services for Oracle WebLogic Server: Appendix A: Using Oracle Web Service Security Policies

Use MTOM with Web Services

Oracle Fusion Middleware Securing WebLogic Web Services for Oracle WebLogic Server: Section 2.2: Example of Adding Security to MTOM Web Service

4.2.6 Additional Security Configuration Documentation

Most security procedures do not require steps unique to Oracle UCM and can be performed by following the documentation listed in Table 4-4.

Table 4-4 Security Documentation

For Information On...

See The Following Guide...

Securing Oracle Fusion Middleware

Oracle Containers for J2EE Security Guide

Securing and administering Web services

Oracle Application Server Web Services Security Guide

Understanding Oracle WebLogic Server security

Oracle Fusion Middleware Understanding Security for Oracle WebLogic Server

Securing an Oracle WebLogic Server production environment

Oracle Fusion Middleware Securing a Production Environment for Oracle WebLogic Server

Securing Oracle WebLogic Server

Oracle Fusion Middleware Securing Oracle WebLogic Server

Developing new security providers for use with Oracle WebLogic Server

Oracle Fusion Middleware Developing Security Providers for Oracle WebLogic Server

Securing Web service for Oracle WebLogic Server

Oracle Fusion Middleware Securing WebLogic Web Services for Oracle WebLogic Server

Programming security for Oracle WebLogic Server

Oracle Fusion Middleware Programming Security for Oracle WebLogic Server

4.3 Security Groups, Roles, and Permissions

This section covers the following topics:

- "Introduction to Security Groups"

- "Managing Groups on Content Server"

- "Introduction to Roles and Permissions"

- "Managing Roles and Permissions on Content Server"

4.3.1 Introduction to Security Groups

A security group is a set of files grouped under a unique name. Every file in the Content Server repository belongs to a security group. Access to security groups is controlled by the permissions, which are assigned to roles on Content Server. Roles are assigned to users where they are managed on Oracle WebLogic Server.

Users are assigned groups in Oracle WebLogic Server. When a user logs in to Content Server, the user's groups are mapped to Content Server roles. Oracle WebLogic Server user groups that start with a @ ("at") symbol are mapped to Content Server accounts.

For Oracle WebLogic Server groups to be recognized in Content Server, roles with the exact same names must be created in Content Server and assigned to security groups. If this is not done, the Oracle WebLogic Server groups assigned to users has no impact on users' privileges in Content Server.

Security groups enable you to organize content files into distinct groups that can be accessed only by specific users. For example, files could be assigned to a security group with the name HRDocs, which could represent documents under the Human Resources designation, and could be accessed only by people who worked in the Human Resources department. There are two predefined security groups:

- Public: By default, any user can view documents in the Public group without logging in.

- Secure: System files are stored in the Secure group and are available only to the system administrator.

4.3.1.1 Best Practices for Working with Security Groups

Keep these considerations in mind when you define security groups:

- Define security groups before anyone checks in files that must be secure.

- The number of security groups should be kept at a minimum to provide optimum search performance and user administration performance. If your security model requires more than 50 security classifications, you should enable accounts and use them to control user permissions. This number varies depending on Search Performance and User Admin Performance.

- Put all files that share the same access into one security group.

- Set up a logical naming convention for your security groups. For example, use department names if you are setting up an intranet, and use levels of security (internal, classified, and so forth) if you are setting up an extranet.

For example, Figure 4-2 shows three defined security groups (Public, HRDocs, and EngDocs). They are associated with five users assigned different roles (Admin, Contributor, Guest, Sysadmin, Subadmin) and specific sets of permissions (Read, Write, Delete, All).

Figure 4-2 Example of Defining Security Groups

4.3.1.2 Performance Considerations

Your user access choices for security groups and roles can affect the following system performance areas:

- Search Performance

- User Admin Performance

4.3.1.2.1 Search Performance

Search performance is affected by the number of security groups a user has permission to access. To return only content that a user has permission to view, the database WHERE clause includes a list of security groups. The WHERE clause either includes all of the security groups the user has permission to access, or it includes all of the security groups the user does not have permission to access. Which approach is taken depends on whether the user has permission to more than 50% or fewer than 50% of the defined security groups.

For example, if 100 security groups are defined, and a user has permission to 10 security groups, the 10 security groups will be included in the WHERE clause. In contrast, for a user with permission to access 90 security groups, the WHERE clause includes the 10 security groups the user does not have permission to access.

Therefore, if a user has permission to almost 50% of the security groups, the search performance is less efficient. If a user has permission to all or none of the security groups, the search performance is more efficient.

4.3.1.2.2 User Admin Performance

The total number of security groups multiplied by the total number of roles determines the number of rows in the RoleDefinition database table, which affects the performance of the User Admin application for operations involving local users. To determine the approximate time required to perform an operation in the User Admin application, such as adding a security group or changing permission for a role, use the following formula:

(# of security groups) X (# of roles) / 1000 = Time of operation in seconds

For example, using a PC with a 400 MHz processor, 128 MB of RAM, it took approximately 10 seconds to add a security group, or role, or both, using the User Admin application when the RoleDefinition table has 10,000 rows.

As the number of security groups increases, administration performance is affected more than consumer search performance.

4.3.2 Managing Groups on Content Server

The following tasks are used to manage security groups using Content Server.

- "Adding a Security Group on Content Server"

- "Deleting a Security Group on Content Server"

For information on managing groups, see Oracle WebLogic Server Admin Console Help.

4.3.2.1 Adding a Security Group on Content Server

To create a security group and assign permissions:

1. From the User Admin Screen, select Security, and then Permissions by Group.
The Permissions By Group Screen is displayed.

2. Click Add Group to display the Add New Group Screen.

3. Enter a group name and description.

4. Click OK.

5. Set permissions for the security group:

1. Select the security group.

2. Select the role to edit.

3. Click Edit Permissions.

4. After enabling the permissions that you want the role to have for the group, click OK to close the Permissions by Group screen.

4.3.2.2 Deleting a Security Group on Content Server

To delete a security group:

1. Make sure that no content items are assigned to the security group you want to delete. You cannot delete a security group if content still exists in that security group.

2. From the User Admin Screen, select Security, and then Permissions by Group.
The Permissions By Group Screen is displayed.

3. Select the group you want to delete.

4. Click Delete Group.
A confirmation screen is displayed.

5. Click Yes.
The security group is deleted.

6. After you have deleted the security group, click OK to close the Permissions by Group screen.

4.3.3 Introduction to Roles and Permissions

A role is a set of permissions (Read, Write, Delete, Admin) for each security group. You can think of a role as a user's job. Users can have different jobs for various security groups. Users can also have different jobs to identify the different teams in which they participate. You can:

- Define roles.

- Assign multiple roles to a user.

- Set up multiple users to share a role.

- Set the role's permissions to multiple security groups.

For example, Figure 4-3 shows three roles and the permissions those roles have to the same security group.

Figure 4-3 Example of Roles and Their Permissions

Roles are assigned to one or more users by the system administrator to provide access to the security groups. Figure 4-4 shows the EngUsers role with only Read permission to the HRDocs security group. However, this role provides Read, Write, and Delete permissions to the EngDocs security group. This provides an added measure of security, ensuring that only users who need access to certain documents can modify them.

Figure 4-4 Example of Roles and Security Group Access

4.3.3.1 Predefined Roles

The following roles are predefined on Content Server:

Roles

Description

admin

The admin role is assigned to the system administrator. By default, this role has Admin permission to all security groups and all accounts, and has rights to all administration tools.

contributor

The contributor role has Read and Write permission to the Public security group, which enables users to search for, view, check in, and check out content.

guest

The guest role has Read permission to the Public security group, which enables users to search for and view content.

sysmanager

The sysmanager role has privileges to access the Admin Server on the content server.

4.3.3.2 About Permissions

Each role allows the following permissions for each security group: Read (R), Write (W), Delete (D), or Admin (A). The permission that a user has to access the files in a security group is the highest permission defined by any of the user's roles. If a user has the guest and contributor roles, where guest is given Read permission and contributor is given Write permission to the Public security group, the user will have Write permission to content in the Public security group.

As shown in Figure 4-5, Joe Smith and Ann Wallace have permissions to two security groups:

- Joe Smith has Read, Write, and Delete permission to the EngDocs security group, but only Read permission to the HRDocs security group. As a member of the EngUsers role, he has been given Read, Write, and Delete access to Engineering Documents, but only Read access to Human Resource documents.

- Ann Wallace has Read, Write, and Delete permission to the HRDocs security group, but only Read permission to the EngDocs security group. As a member of the HRUsers role, she has been given Read, Write, and Delete access to Human Resource documents, but only Read access to Engineering documents.

Figure 4-5 Example of Assigned Permissions

4.3.3.3 Predefined Permissions

Each role allows the following permissions to be assigned for each security group:

Permission

Description

Read

Allowed to view files in that security group.

Write

Allowed to view, check in, check out, and get a copy of documents in that security group. The author can change the security group setting of a document if the non-author has Write permission in the new security group.

Delete

Allowed to view, check in, check out, get a copy, and delete files in that security group. The configuration setting AuthorDelete=true adds delete permission to all security groups to which the author has Write permission.

Admin

Allowed to view, check in, check out, get a copy, and delete files in that security group. If this user has Workflow rights, they can start or edit a workflow in that security group.
Users are also allowed to check in documents in that security group with another user specified as the Author. Non-authors can change the security group setting of a document if the non-author has write permission in the new security group.

4.3.4 Managing Roles and Permissions on Content Server

Roles and permissions are defined and managed on Content Server. Roles are assigned to user logins which are managed on Oracle WebLogic Server.

The following tasks are used to manage user roles.

- "Creating a Role on Content Server"

- "Deleting a Role on Content Server"

- "Assigning Roles to a User on Oracle WebLogic Server"

- "Assigning Roles to Create Similar Users on Oracle WebLogic Server"

- "Adding and Editing Permissions on Content Server"

4.3.4.1 Creating a Role on Content Server

To create a role and configure permissions:

1. From the User Admin Screen, select Security, and then Permissions by Role.
The Permissions By Role Screen is displayed.

2. Click Add New Role.
The Add New Role Screen is displayed.

3. Enter a Role Name.

4. Set permissions for the role:

1. Select the role.

2. Select the security group to edit.

3. Click Edit Permissions.

4. Edit the permissions.

5. Click OK and close the Permissions By Role Screen.

4.3.4.2 Deleting a Role on Content Server

To delete a role:

1. Make sure that no users are assigned to the role to delete. (You can not delete a role if any users are assigned to it.)

2. From the User Admin Screen, select Security, and then Permissions by Role.
The Permissions By Role Screen is displayed.

3. Select the role to delete.

4. Click Delete Role.
A confirmation screen is displayed.

5. Click Yes.

4.3.4.3 Assigning Roles to a User on Oracle WebLogic Server

To assign roles to a user for a Content Server instance, use the Oracle WebLogic Server Administration Console. While roles are defined on Content Server, they must be assigned to users on Oracle WebLogic Server.

4.3.4.4 Assigning Roles to Create Similar Users on Oracle WebLogic Server

To assign roles to create similar users, use the Oracle WebLogic Server Administration Console. While roles are defined on Content Server, they must be assigned to users on Oracle WebLogic Server.

4.3.4.5 Adding and Editing Permissions on Content Server

To add permissions to a role or edit existing permissions, follow this procedure in Content Server:

1. From the User Admin Screen, select Security, and then Permissions by Role.
The Permissions By Role Screen is displayed.

2. Either select an existing role, or add a new role.
The permissions associated with the security groups are displayed.

3. Select an item in the Groups/Rights column.

4. Click Edit Permissions.
The Edit Permissions Screen is displayed.

5. Specify the permissions to associate with this role and security group. See "Predefined Permissions".

6. Click OK.

4.4 Accounts

Accounts are defined and managed on Content Server. Accounts permissions are assigned to user logins on Oracle WebLogic Server.

This section covers the following topics:

- "Introduction to Accounts"

- "Managing Accounts"

- "An Accounts Case Study"

4.4.1 Introduction to Accounts

Accounts give you greater flexibility and granularity in your security structure than security groups alone provide. Accounts and account permissions are assigned to users with the Oracle WebLogic Server Administration Console, and the server maps groups to Content Server roles and permissions. An account can also be assigned to each content item. To access a content item that has an account assigned to it, the user must have the appropriate permission to the account.

Oracle WebLogic Server user groups that start with a @ ("at") symbol are mapped to Content Server accounts.

Note:
If you enable accounts and use them, then later choose to disable accounts, you can have the perception of losing data. The repository remains intact. However, if you make certain changes to the security model, then you also must update the users' access rights so they can continue to access the secure content.
To avoid this situation, examine your requirements and the Oracle UCM security model of groups and accounts to determine what would best match your needs. Unless you are certain that you want to use accounts, do not enable them.

There are several ways accounts can be created:

- The system administrator creates predefined accounts using the User Admin tool. See "Creating Predefined Accounts on Content Server".

- A user administrator creates an account while checking in content. See "Creating Accounts When Checking In Content on Content Server".

You must enable accounts to be able to use them. See "Enabling Accounts on Content Server" for more information.

4.4.1.1 Accounts and Security Groups

When accounts are used, the account becomes the primary permission to satisfy before security group permissions are applied. You can also think of a user's access to a particular document as the intersection between their account permissions and security group permissions.

For example, the EngAdmin role has Read, Write, Delete, and Admin permission to all content in the EngDocs security group. A user is assigned the EngAdmin role, and is also assigned Read and Write permission to the AcmeProject account. Therefore, the user has only Read and Write permission to a content item that is in the EngDocs security group and the AcmeProject account.

Figure 4-6 shows the intersection of the AcmeProject account and EngDocs security group permissions.

Figure 4-6 Example of Security Group Permissions

Security group permissions are ignored if the account does not permit access to any content. Remember that the account acts as a filter that supersedes the permissions defined by the user's roles.

4.4.1.2 Hierarchical Accounts

Accounts can be set up in a hierarchical structure, which enables you to give some users access to entire branches of the structure, while limiting permissions for other users by assigning them accounts at a lower level in the structure. Figure 4-7 shows a typical hierarchical account structure.

Figure 4-7 Example of Hierarchical Account Structure

Important:
Because account names form part of the directory path for the URL of a content item, account names cannot exceed 30 characters.

- If you use slashes to separate the levels in account names (for example, Eng/Acme/Budget), Content Server creates a weblayout directory structure according to your account structure. (However, each actual directory will not be created until a content item is assigned to the account during the check-in process.) Each lower level in the account name becomes a subdirectory of the upper level, with an @ symbol prefix to indicate that the directory is an account level.

- If a user has permission to a particular account prefix, they have access to all accounts with that prefix. For example, if you are assigned the Eng/XYZ account, you have access to the Eng/XYZ account and any accounts that begin with the Eng/XYZ prefix (such as Eng/XYZ/Schedule and Eng/XYZ/Budget).

Important:
The account prefix does not have to include slashes. For example, if you have accounts called abc, abc_docs, and abcdefg, all users who have access to the abc account will have access to the other two accounts as well.

To handle the security structure depicted above, you would create the following accounts:

- Eng

- Eng/Acme

- Eng/XYZ

- Eng/Acme/Schedule

- Eng/Acme/Budget

- Eng/XYZ/Schedule

- Eng/XYZ/Budget

Figure 4-8 Example of a Security File Structure

4.4.1.3 Performance Considerations

Consider the following performance issues when using accounts in your security model:

- Theoretically, you can create an unlimited number of accounts without affecting Content Server performance. A system with over 100,000 pieces of content has only limited administration performance problems at 200 accounts per person; however, there is significant impact on search performance with over 100 accounts per person. (Note that these are explicit accounts, not accounts that are implicitly associated with a user through a hierarchical account prefix. A user can have permission to thousands of implicit accounts through a single prefix.)

- For performance reasons, do not use more than approximately 50 security groups if you enable accounts.

- Ensure that your security groups and accounts have relatively short names.

4.4.1.4 External Directory Server Considerations

Accounts are available whether or not your Content Server is integrated with an external directory server (such as JPS User provider for Oracle WebLogic Server) . When you use accounts with an external directory, ensure that you follow these guidelines:

- Set up a global group with the appropriate users in it to match the account.

- Associate group names to either a role or an account by configuring mapping prefixes.

4.4.2 Managing Accounts

The following tasks are involved in managing accounts.

- "Enabling Accounts on Content Server"

- "Creating Predefined Accounts on Content Server"

- "Creating Accounts When Checking In Content on Content Server"

- "Deleting Predefined Accounts on Content Server"

- "Assigning Accounts to a User on Oracle WebLogic Server"

4.4.2.1 Enabling Accounts on Content Server

To enable accounts:

Important:
If you enable accounts and use them, then choose to disable accounts, you can have the perception of losing data. The repository remains intact. However, if you make certain changes to the security model, then you also must update the security settings for users so they can continue to access the content.

1. On the Content Server portal, select Administration, then click Admin Server.

2. On the Admin Server page, click General Configuration.

3. On the General Configuration page, select the Enable Accounts check box to enable accounts.

4. Save the changes.

5. Restart the Content Server.

Alternately, you can access the General Configuration page from the Admin Server, then add the following line to the Additional Configuration Variables field, which shows the contents of the IntradocDir/config/config.cfg file:

UseAccounts=true

Save the changes, and restart the Content Server.

4.4.2.2 Creating Predefined Accounts on Content Server

To create a predefined account:

1. From the User Admin screen, select Security, and then select Predefined Accounts.
The Predefined Accounts Screen is displayed.

2. Click Add.
The Add New Predefined Account Screen is displayed.

3. Add the name of the new account. Keep the names short and consistent. For example, set up all of your accounts with a three-letter abbreviation by location or department (MSP, NYC, etc.). Account names can be no longer than 30 characters, and the following are not acceptable: spaces, tabs, line feeds, carriage returns, and the symbols : ; ^ ? : & + " # % < > * ~.

4. Click OK.

5. If you already have content checked into the Content Server and you are using a database with full text indexing, rebuild your search index.
If you are using only the metadata database search indexer engine, you do not need to rebuild your search index.

4.4.2.3 Creating Accounts When Checking In Content on Content Server

Generally, you should create predefined accounts rather than creating an account during content checkin. See "Creating Predefined Accounts on Content Server".

To create an account at the time you check in a content item, you must have User Admin rights, and perform these tasks:

1. Display the Content Check In Form page.

2. Enter all required and optional information.

3. Type an account name in the Account field.

4. Click Check In.
The new account is assigned to the content item.

4.4.2.4 Deleting Predefined Accounts on Content Server

To delete a predefined account:

1. Select Security and then select Predefined Accounts.
The Predefined Accounts Screen is displayed.

2. Select the account to delete.

3. Click Delete.
The account is deleted immediately.

You can delete an account even if content with that account still exists. The account value will remain assigned to the content item, but will be considered a user-defined account.

4.4.2.5 Assigning Accounts to a User on Oracle WebLogic Server

To assign an account to a user, use the Oracle WebLogic Server Administration Console to create a group and then assign it to one or more users. The group name must start with the @ sign and end with permissions enclosed in parentheses. The following example creates a group named testaccount and assigns it Read, Write, and Delete permissions: @testaccount(RWD).

Accounts assigned to a user on Oracle WebLogic Server are mapped to the content server. For more information, see Oracle Fusion Middleware Oracle WebLogic Server Administration Console Online Help.

4.4.3 An Accounts Case Study

In this example, Xalco is a worldwide software company with offices in London, New York, and Paris. They have a content server hosted in the London office, with access from the other offices through the corporate WAN. At the same time, Xalco is replicating some files out to an area of their public Web site. Initially, the Sales and Finance departments at each location want to use their instance to publish files. The New York office is small and has no Sales department.

The following sections provide sample information for the Xalco case study:

- "Xalco Security"

- "Xalco Accounts"

- "Xalco Roles"

- "Roles and Permissions Table"

- "Roles and Users Table"

- "Accounts and Users Table"

4.4.3.1 Xalco Security

- Xalco staff and security levels:

- London: David Smith, Worldwide CFO, and Jim McGuire, UK Sales Manager

- New York: Catherine Godfrey, Regional Finance Manager

- Paris: Helene Chirac, Finance Clerk (Europe)

- Xalco levels of security clearance (security groups) for Xalco content:

- Public: Files suitable for consumption by members of the public (public content is replicated to the Xalco Web site)

- Internal: Files which have unrestricted access internally, but are not suitable for public consumption

- Sensitive: Files which are commercially sensitive, and restricted to middle managers and above

- Classified: Highly-sensitive files, suitable only for board members

- Xalco staff access:

- David Smith: As Worldwide CFO, he requires full access to all files held in the instance.

- Jim McGuire: As UK Sales Manager, he must have full control of Sales files in London, and have visibility of sales activities in Paris. As a manager, he has clearance to the Sensitive level.

- Helene Chirac: Based in the Paris office, she must view only files relating to Finance in Europe, and she has clearance only to the Internal level.

- Catherine Godfrey: As a Regional Finance Manager based in New York, she must contribute Finance files for New York and view all other Finance documents. As a manager, she has clearance to Sensitive level.

4.4.3.2 Xalco Accounts

Access varies by location and job function, so this is reflected in the account structure:

- London has Finance and Sales departments, so it needs two accounts:

- London/Finance

- London/Sales

- New York has only a Finance department:

- NewYork/Finance

- Paris has both Finance and Sales departments:

- Paris/Finance

- Paris/Sales

This results in three top-level accounts (London, NewYork, Paris) and five lower-level accounts.

4.4.3.3 Xalco Roles

We need to create two roles for each security group (one for Consumers and one for Contributors)

- PublicConsumer

- PublicContributor

- InternalConsumer

- InternalContributor

- SensitiveConsumer

- SensitiveContributor

- ClassifiedConsumer

- ClassifiedContributor

4.4.3.4 Roles and Permissions Table

To give specific users the ability to start workflows, you would need to add Admin permission and Workflow rights to the Contributor role.

Role

Public

Internal

Sensitive

Classified

PublicConsumer

R

PublicContributor

RWD

InternalConsumer

R

InternalContributor

RWD

SensitiveConsumer

R

SensitiveContributor

RWD

ClassifiedConsumer

R

ClassifiedContributor

RWD

4.4.3.5 Roles and Users Table

Role

David Smith

Helene Chirac

Jim McGuire

Catherine Godfrey

PublicConsumer

X

PublicContributor

X

X

X

InternalConsumer

X

InternalContributor

X

X

X

SensitiveConsumer

SensitiveContributor

X

X

X

ClassifiedConsumer

ClassifiedContributor

X

X

X

4.4.3.6 Accounts and Users Table

It would be sufficient to give David Smith RWDA permission on London, New York, and Paris accounts.

Account

David Smith

Helene Chirac

Jim McGuire

Catherine Godfrey

London/Finance

RWDA

R

R

London/Sales

RWDA

RWDA

NewYork/Finance

RWDA

RW

Paris/Finance

RWDA

R

Paris/Sales

RWDA

R

4.5 User Logins and Aliases

This section covers the following topics:

- "Introduction to User Logins and Aliases"

- "Managing Logins and Aliases"

- "User Information Fields"

4.5.1 Introduction to User Logins and Aliases

User logins are the names associated with the people who access Content Server. In 11g Release 1 (11.1.1) and later, user logins must be created on the Oracle WebLogic Server that hosts Oracle UCM and the Content Server instance. Authentication and credentials are handled by Oracle WebLogic Server and associated security software instead of by Content Server. For more information, see Oracle Fusion Middleware Security Guide.

Caution:
Although user logins still can be created and managed on Content Server with the User Admin applet, they are not valid for authentication purposes unless they also have been created on Oracle WebLogic Server.
If you use an LDAP server and create a user login with the same name as a local user defined in Content Server with the User Admin applet, the LDAP user is authenticated against LDAP when logging in, but receives roles assigned to the local user.

The Oracle WebLogic Server administrator assigns one or more groups to each user. A group provides the user access to files within the security groups. Undefined users are assigned to the guest group, which allows viewing of documents only in the Public security group by default.

You can also create a group of users that can be then referenced by a single name, or alias, in workflows, subscriptions, and projects. For example, it is much easier to add an alias called Support to a workflow than it is to add user1, user2, user3, and so on.

Figure 4-9 Example of a User With Roles

If you log in to multiple browser windows on the same computer using different login methods (such as standard login, Microsoft login, or self-registered login), the Content Server can become confused about which user is logged in to each window. Remember to close any open browser windows while testing different login methods.

Important:
User logins are case sensitive.

4.5.2 Managing Logins and Aliases

User logins must be created and managed on the Oracle WebLogic Server. For information and instructions on creating and managing user logins, see Oracle WebLogic Server Administration Console Online Help.

If you need to set up a user (other than the Content Server administrator) to work with a standalone Content Server utility such as System Properties, you can use the User Admin applet in Content Server. However, a user created with the User Admin applet cannot be authenticated for any other functions than standalone Content Server utilities, unless the user is also created in Oracle WebLogic Server.

The remainder of this section discusses the tasks involved in managing Content Server user logins only for standalone utilities.

- "Adding a User Login"

- "Editing a User Login"

- "Deleting a User Login"

- "Creating an Alias"

- "Editing an Alias"

- "Deleting an Alias"

4.5.2.1 Adding a User Login

Note:
As of 11g Release 1 (11.1.1), user logins must be managed on Oracle WebLogic Server. Although user logins can be managed in Content Server for special purposes, they are not valid for authentication to Content Server until they have been created on Oracle WebLogic Server.

To add a user login only for use with Content Server standalone utilities:

1. From the User Admin Screen: Users Tab, click Add.

2. Set the Authorization Type from the menu. See "Types of Users" for more information.

3. Click OK.
The Add/Edit User Screen is displayed.

4. Enter information about the user.

- If you enter a password, you must reenter the same password in the Confirm Password field.

- Keep in mind that the user name and password are case-sensitive.

5. Assign roles to the user.

6. If accounts are enabled, assign accounts to the user.

7. Click OK.

4.5.2.2 Editing a User Login

Note:
As of 11g Release 1 (11.1.1), user logins must be managed on Oracle WebLogic Server. Although user logins can be managed in Content Server for special purposes, they are not valid for authentication to Content Server until they have been created on Oracle WebLogic Server.

To edit a user login only for use with Content Server standalone utilities:

1. From the Users tab of the User Admin Screen, double-click the user name, or select the user name and click Edit.
The Add/Edit User Screen or Add/Edit User Screen: Info Tab (Global User) is displayed.

2. Edit the user login as necessary.

If you change the user locale for a user who has the sysmanager role, you must restart the Admin Server service for the Admin Server interface to appear in the user's locale language.

4.5.2.3 Deleting a User Login

Note:
As of 11g Release 1 (11.1.1), user logins must be managed on Oracle WebLogic Server. Although user logins can be managed in Content Server for special purposes, they are not valid for authentication to Content Server until they have been created on Oracle WebLogic Server.

To delete a user login only for use with Content Server standalone utilities:

1. From the Users tab of the User Admin Screen, select the user name.

2. Click Delete.
A confirmation screen is displayed.

3. Click Yes.

If you delete a user who is involved in a workflow, you are prompted to confirm the deletion. You must adjust the workflow and remove the user from the list of workflow reviewers.

4.5.2.4 Creating an Alias

Note:
As of Oracle UCM 11g Release 1 (11.1.1), user logins must be managed on Oracle WebLogic Server. Although user logins can be managed in Content Server for special purposes, they are not valid for authentication to Content Server until they have been created on Oracle WebLogic Server.

To define an alias only for use with Content Server standalone utilities:

1. Display the User Admin Screen: Aliases Tab.

2. Click Add.
The Add New Alias/Edit Alias Screen is displayed.

3. In the Alias Name field, enter a name that identifies the group of users.

4. In the Description field, enter a detailed description of the alias.

5. Click Add.
The Select Users Screen is displayed.

6. Select the user names from the list.

- To narrow the list of users on the Select Users screen, select the Use Filter check box, click Define Filter, select the filter criteria, and click OK.

- To select a range of users, click one user login and then hold down the Shift key while clicking another user login.

- To select users individually, hold down the Ctrl key while clicking each user login.

7. Click OK.

8. Close the User Admin screen.

4.5.2.5 Editing an Alias

Note:
As of 11g Release 1 (11.1.1), user logins must be managed on Oracle WebLogic Server. Although user logins can be managed in Content Server for special purposes, they are not valid for authentication to Content Server until they have been created on Oracle WebLogic Server.

To edit an alias only for use with Content Server standalone utilities:

1. Display the User Admin Screen: Aliases Tab.

2. Highlight an alias and click Edit.
The Add New Alias/Edit Alias Screen is displayed.

3. Alter the information as needed.

4. In the Description field, enter a detailed description of the alias.

5. Click OK.

6. Close the User Admin screen.

4.5.2.6 Deleting an Alias

Note:
As of 11g Release 1 (11.1.1), user logins must be managed on Oracle WebLogic Server. Although user logins can be managed in Content Server for special purposes, they are not valid for authentication to Content Server until they have been created on Oracle WebLogic Server.

To delete an alias only for use with Content Server standalone utilities:

1. Display the Add New Alias/Edit Alias Screen.

2. Highlight the alias to be deleted and click Delete.
A screen appears, asking you to confirm the deletion. Click Yes to delete the entry or No to retain it.

3. Close the User Admin screen.

4.5.3 User Information Fields

This section covers these topics:

- "About User Information Fields"

- "Adding a New User Information Field"

- "Editing an Option List"

- "Editing a User Information Field"

4.5.3.1 About User Information Fields

User information defines the unique attributes of a user, such as full name, password, and e-mail address. User information fields describe a user in the same way that metadata fields describe a content item. User information is stored in the Content Server database, and can be used to sort users, display user information on Content Server Web pages, or customize the display of Web pages based on user attributes.

The following user information fields are predefined in the system. These fields cannot be deleted, and the field name and type cannot be changed.

Name

Type

Caption

Is Option List

dFullName

Long Text

Full Name

False

dEmail

Long Text

E-mail Address

False

dUserType

Text

User Type

True

dUserLocale

Text

User Locale

True

4.5.3.2 Managing User Information Fields

This section describes the tasks involved in managing user information fields.

- "Adding a New User Information Field"

- "Editing an Option List"

- "Editing a User Information Field"

4.5.3.2.1 Adding a New User Information Field

To add a new user information field:

1. On the User Admin Screen: Information Fields Tab, click Add.
The Add Metadata Field Name Screen is displayed.

2. Enter a new field name. Duplicate names are not allowed. Maximum field length is 29 characters. The following are not acceptable: spaces, tabs, line feeds, carriage returns and ; ^ ? : @ & + " # % < * ~ |

3. Click OK.
The Edit Metadata Field Screen is displayed.

4. Configure the properties for the field, and click OK.

5. Click Update Database Design.

4.5.3.2.2 Editing an Option List

To edit an option list key:

1. On the Edit Metadata Field Screen, select the Enable Option List check box.

2. Click Edit.
The Option List Screen is displayed.

3. Add, edit, or delete option values.

- Each value must appear on a separate line.

- A blank line will result in a blank value in the option list.

4. To sort the list, select sort options and click Sort Now.

5. Click OK.

4.5.3.2.3 Editing a User Information Field

To edit a user information field:

1. Double-click the field, or select the field and click Edit.
The Edit Metadata Field Screen is displayed.

2. Add, edit, or delete option values.

3. Click OK.

4.6 Security and Content Server Providers

For Oracle UCM and Content Server, it is recommended that you use the JpsUserProvider to communication user information and credentials managed with Oracle WebLogic Server. The JpsUserProvider is the default provider for Content Server. For details, see "When to Add a JPS User Provider".

If a site is upgrading from an earlier release of Content Server and is using Active Directory, LDAP, or Active Directory with LDAP, information about those providers is available in the 10gR3 document Managing Security and User Access. It is strongly recommended that sites upgrade to use JpsUserProvider.

4.7 Additional Content Server Security Connections

This section provides information about additional security communication connection options for Content Server. It covers the following:

- "About Proxy Connections"

- "Credentials Mapping"

- "Secured Connections to Content Servers"

- "Connections Using the HTTP Protocol"

4.7.1 About Proxy Connections

Proxy connections, or connections between content server instances, provide additional levels of security for Content Server through the following functions:

- Security credentials mapping from one content server to another content server.

- Secured "named" password connections to content servers (password protected provider connections).

- HTTP protocol communication between content servers.

While it is possible to use both named password connections and HTTP-based content server communication, it is most likely that one type of connection will be more useful. For both types of connections, credentials mapping can provide additional security.

Note:
A site can have multiple Content Server instances, but each Content Server instance must be installed on its own Oracle WebLogic Server domain.

Typical uses of the ProxyConnections8 component include the following:

- To provide the capability to perform archive replication of content items. For example, a company has acquired another company, but they do not a have common infrastructure for sharing information. Both companies have a Secure Sockets Layer (SSL) connection to the Internet. The company wants to share content between the two sites. ProxyConnections can be used to set up a secure Internet connection between the companies' servers so that content can be securely accessed from one site, replicated, and archived at the other site.

- To better restrict access to Content Servers by using named passwords to target proxy connections. For example, a company wants to apply additional security to connections coming from one Content Server to another Content Server. Using named passwords, an administrator can restrict access by incoming connections to those with preset proxy connections and named passwords.

The ProxyConnections8 component is installed (enabled) by default with Content Server.

4.7.2 Credentials Mapping

Administrators can create multiple credentials maps for users, roles, and accounts. Credentials mapping can be useful in a master-to-master scenario, for example, where credentials for users, roles, or accounts created on a Content Server instance can be mapped to the users, roles, or accounts on another Content Server instance, thus allowing users controlled access to information on more than one Oracle Content Server.

This section covers the following topics:

- About Credentials Mapping

- Credential Values

- Matching Accounts and Roles

- Creating a Credentials Map

4.7.2.1 About Credentials Mapping

When you create a credentials map you enter a unique identifier for the map and specific credential values for users, roles, and accounts. In a proxy connection, when user credentials match an input value, then the user is granted the credentials specified in the output value. The user credentials are evaluated in the following order:

1. All the roles.

2. All the accounts.

3. The user name.

After the translation is performed, the user only has the attribute values that were successfully mapped from input values.

When you have created credential maps, you can specify a credentials map along with a named password connection when configuring an outgoing provider. You also can specify a credentials map when configuring a user provider (such as LDAP).

The default behavior for an LDAP provider is that the guest role is not automatically assigned to users.

Credentials mapping implementation is duplicated in the Web server plug-in and in Content Server. It is designed and implemented for optimal performance, so that any changes in the mapping are applied immediately. (This can be compared to performance in NT or ADSI user storage using the NT administrator interfaces, where changes are cached and not reflected in the Content Server for up to a couple of minutes.)

4.7.2.2 Credential Values

A credential input value is matched if there is an exact match in the case of a role or user name. An input account value is matched if one of the user accounts has a prefix, except for the case of a filter (see "Matching Accounts and Roles"). For example, the following credential values reduce all users who might otherwise have the admin role to instead have the guest role:

admin, guest

The following table lists the basic syntax for credential values:

Value

Prefix or Sequence

Example

User name

&

&name

Role

admin

Account

@

@marketing

Empty account

@#none

@#none

All accounts

@#all

@#all

Ignore the value or "comment out" the value

#

#comment

You can view which credentials are applied by default if no credential map is assigned. Use the following mapping, which maps everything without change. This mapping first filters all roles, then all accounts. For additional information about mapping syntax see "Matching Accounts and Roles".

|#all|,%%
@|#all|,@%%

Caution:
If your credentials map does not at least assign the minimum set of privileges that an anonymous user gets when visiting the Content Server Web site, then logged in users may experience unusual behavior. For example, a common reaction for a browser that receives an ACCESS DENIED response is to revert back to being an anonymous user. In particular, a user may experience unpredictable moments when it is possible or not possible to access a document (depending on whether at that moment the browser chooses to send or not to send the user's authentication credentials). This is particularly true of NTLM authentication because that authentication has to be renewed periodically.

4.7.2.3 Matching Accounts and Roles

A special filter is available for matching accounts and roles. For example, the syntax for an account filter is designated by starting the account value with specifying the prefix @| and ending with a | (for example, @|accountname| ). The pipe (|) represents a command redirection operator that processes values through the filter. For proxied connections a space-separated list of accounts is specified; each account optionally starts with a dash (-) to denote a negative value. A filter is matched if any of the specified account strings that do not start with a dash are a prefix for a user account and all of the account strings that do start with a dash are not prefixes for that user account.

Caution:
The filter will not map the account @#all. The all accounts account value must be mapped explicitly by using @#all, @#all mapping.

Roles can be mapped (using the same rules) by removing the @ sign from the beginning of the filter. For example, the following input value passes through all roles except those that begin with the prefix visitor. Note that the expression #all matches all roles.

|#all -visitor|, %%

4.7.2.3.1 Reference Input Value

The special sequence %% in the output value can be used to reference the input value. For example, given the following mapping, any account that did not start with financial as a prefix would map to the same account but with the prefix employee/ attached at the front:

@|#all -financial|, @employee/%%

If a user had the account marketing, then after the mapping the user would have the account employee/marketing.

4.7.2.3.2 Privilege Levels

A particular privilege level (read, write, delete, all) can be granted to an account in the output value by following the account specification with the letters "R", "W", "D", or "A" enclosed in parentheses. For example, all the privilege levels for all the accounts could be reduced to having read privilege by the following syntax:

@|#all -financial|, @employee/%%(R)

4.7.2.3.3 Substitution

In certain cases it is useful to remove a prefix before the substitution %% is applied. An offset for the substitution can be specified by using the syntax %%[n] where n is the starting offset to use before mapping the input value into the %% expression. The offset is zero based so that %%[1] removes the first character from the input value. For example, to remove the prefix DOMAIN1\ from all roles, the following expression can be used:

|domain1\|, %%[8]

Another use for this function might be to replace all accounts that begin with the prefix marketing/ and replace it with the prefix org1/mkt. The expression for this would look like the following:

@|marketing/|, @org1/mkt/%%[10]

4.7.2.3.4 Special Characters

In certain cases roles will have unusual characters that may be hard to specify in the input values. The escape sequence %xx (where xx is the ASCII hexadecimal value) can be used to specify characters in the input value. For example, to pass through all roles that begin with #,& |@ (hash, comma, ampersand, space, pipe, at) the following expression can be used:

|%35%2c%26%20%7c%40|, %%

4.7.2.4 Creating a Credentials Map

To create a credentials map, follow these steps:

1. Open a new browser window and log in to Content Server as the system administrator.

2. Select Administration and then select Credential Maps.
The Credential Maps Screen is displayed.

3. Enter the unique identifier for the credentials map you are creating.
More than one named password connection can be used to connect to a Content Server. Each named password connection can have a different credentials map.

4. Enter values in two columns with a comma to separate the columns and a carriage return between each row of values. The first column specifies input values and the second column specifies output values.

5. Click Update.

To apply a credentials map to roles and accounts retrieved using NT integration, set the Content Server configuration entry ExternalCredentialsMap to the name of the credentials map of your choice.

4.7.3 Secured Connections to Content Servers

Secured connections to Content Servers can be supported by creating password protection on incoming requests. A Content Server instance can communication with another Content Server instance in a password protected fashion.

This section covers the following topics:

- "About Named Password Connections"

- "Guidelines for Proxy Connections Data"

- "Creating a Proxied Connection"

4.7.3.1 About Named Password Connections

Using the Proxied Connection Authentication/Authorization Information Screen you can create named passwords, which are passwords that you assign to specific connections by name. Each named password can be associated with a host and IP address filter on both the direct socket communication to a Content Server and on any communication performed through the controlling Web server (the HTTP filter) for a Content Server. When an outside agent (such as a Web server for another Content Server) wants to communicate with the Content Server, it can use a named password connection. A named password connection also can be associated with a credentials map so that the privileges of users accessing the Content Server can be reduced or changed.

Proxy connections entry fields are provided in the forms for configuring outgoing socket providers and outgoing HTTP providers in which you can specify a named password connection. (To view provider selections for your instance, select Administration, Providers.)

Passwords are hashed (SHA1 message digest) with their allowed host and IP address wildcard filter on the client side. If the copy of a stored password is exposed, it will only allow access from clients that satisfy both the host and IP address filter.

The expiration implementation for passwords means that the various servers involved must have their clocks reasonably synchronized (within a few minutes at least).

Caution:
All passwords are hashed by a time-out value before being sent to a server. If a password value is exposed while in communication to a server, the password will only be usable until the expiration time (approximately fifteen minutes after the time the request is issued). Also, the password will only be usable in a replay attack from the same source host and IP address, as previously described. If firewall-protected internal host and IP addresses are not being used, a very committed attacker could spoof the host and IP addresses by hijacking any of the major DNS servers, an event that has occurred in at least a couple of cases.

4.7.3.2 Guidelines for Proxy Connections Data

The data you enter in the Proxied Connection Authentication/Authorization Information Screen defines different passwords that can be used by external agents to connect to a Content Server. Instead of an external agent being forced to provide a password for each user, which may be unavailable to the client for many reasons (such as message digest algorithms that do not use clear text passwords), proxy connections enable the agent to authenticate using a single named connection password. Each named password connection can be linked to rules to restrict which hosts can connect to the Content Server and to control the privileges granted to users. Each named password connection is uniquely identified, and the calling agent must supply the identifier along with the password.

The host name and IP address filters are used to determine which host names or IP addresses are allowed to use a named password connection when performing direct socket connections to a content server. The rules for defining the filters are identical to those defined in the System Properties editor (the wildcard symbols * = match 0 or many and | = match either or can be used to create flexible rules). If an entry is empty then it provides no restriction on its target attribute (either the host name or IP address of the client depending on which of the following two fields is involved).

Two options are implemented through the Providers page:

- Whenever you add an outgoing provider you have the option to use named password connections and to choose whether the provider is a connecting server (so that Web access and security is controlled through a remote server).

- Whenever you add a user provider (such as LDAP) you can choose to use an available credentials map.

No credentials maps are defined in the Proxied Connection Authentication/Authorization Information Screen. For information on creating a credentials map, see "Credentials Mapping".

4.7.3.3 Creating a Proxied Connection

To create a proxied connection, follow these steps:

1. Open a new Web browser window and log in to Content Server as the system administrator.

2. Click Administration.

3. Click Connection Passwords.
The Proxied Connection Authentication/Authorization Information Screen is displayed.

4. Enter information for the fields in the Proxied Connections page.
If credentials maps exist, you can choose to use an existing credentials map, or you can create one to be used for the proxied connection.

5. Click Update.

4.7.4 Connections Using the HTTP Protocol

Administrators can create a proxy connection between content servers using the HTTP protocol. For example, you could have two content servers where both have Web servers for accessing their functionality. If you have a large number of users who want to use Web browsers to access information on one of the content servers, but not all the users can access that server directly, this feature can be useful.

The HTTP protocol can be useful for transferring Content Server archives. The HTTP provider works with Secure Sockets Layer (SSL), the HTTPS protocol, which enables secure communication between two content servers.

This section covers the following topic:

- "About Using HTTP Protocol for Content Server Connection"

- "Configuring the HTTP Provider"

4.7.4.1 About Using HTTP Protocol for Content Server Connection

Administrators can implement an httpoutgoing provider, configurable through the Providers page, which allows communication from one content server to another content server.

If you choose to add an httpoutgoing HTTP provider, you have the following additional options:

- Specify a CGI URL.

- Specify a named password connection and client IP filter.

To view the httpoutgoing HTTP provider selection, select Administration and then Providers from the Content Server navigation panel.

Creating a proxy connection between content server instances can take some preparation. The content server instances should not use the same relative Web root for their weblayout directories. It may require some component architecture changes to provide the extra navigation links between the servers.

If you set up one content server with its Web server using SSL and the other server's front end uses HTTP, then users who try to access the first server by modifying the other server's URL in a Web browser can get an error because of the differences between HTTPS (requiring a credential) and HTTP. To resolve this issue, use the BrowserUrlPath component, available with Oracle Content Server. For more information, see "Browser URL Customization".

4.7.4.2 Configuring the HTTP Provider

To configure the HTTP provider, complete the following steps.

1. Add an httpoutgoing provider on the first content server.

1. In a browser, go to the Administration page and click Providers.

2. Click Add next to the httpoutgoing provider type.

3. Enter the necessary information for the httpoutgoing provider. For more information see the table for the Outgoing Http Provider Page:

2. Create a proxy connection on the second content server that uses the named password connection and connection password that you specified in the previous step.

1. On this server, select Administration, then Connection Passwords.

2. Fill in the information for the connection. The IP address filter entry should have the IP address of the first server.

4.8 Content Server Communication Customization

The following sections provide information on how to customize access to and communication with Content Server. It includes the following:

- "Login/Logout Customization"

- "Browser URL Customization"

- "Extended User Attributes"

- "Filter Data Input"

4.8.1 Login/Logout Customization

The ExtranetLook component can be used to customize user access by suppressing the interface for users who are not authenticated by Oracle WebLogic Server through error and challenge pages issued by the Web server. See Oracle Fusion Middleware Developer's Guide for Content Server for details about changing the interface.

The ExtranetLook component is installed (disabled) by default with Content Server. To use the component you must enable it with the Component Manager.

4.8.2 Browser URL Customization

The BrowserUrlPath component provides support for determining URL paths used in certain configurations of Content Server and Web servers. This component is installed (disabled) by default with Content Server. To use this component you must enable it with the Advanced Component Manager.

This component is valid for Oracle Universal Content Management Content Server instances deployed on Oracle WebLogic Server and located behind load balancers.

The following topics are discussed in this section:

- "About BrowserUrlPath Customization"

- "Affected Idoc Script Variables and Functions"

- "Determining the URL Path"

- "Changing Absolute Full Path Computation"

- "Changing Administration Path Computation"

4.8.2.1 About BrowserUrlPath Customization

The BrowserUrlPath component overrides certain Idoc Script variables and functions, adds computation to certain variables, and provides additional configuration entries for determining URL paths. The BrowserUrlPath component is only supported with Trays and Top Menu layouts for the Content Server user interface.

- You can configure a system with different Web server front ends. One front end can use HTTP and the other can use HTTPS so that the content server can be accessed simultaneously by Web sites using HTTP and HTTPS. You then must apply the BrowserUrlPath component to enable the content server to handle both types of access.

- If you are using a load balancer that forwards itself as the HTTP host header, then you must apply the BrowserUrlPath component.

BrowserUrlPath configuration variables are located in the UCM_ORACLE_HOME/ucm/idc/components/ BrowserUrlPath/config.cfg file.

Caution:
The BrowserUrlPath component requires extensive configuration using the variables. You may want to back up your configuration before modifying variables

In typical scenarios, the web server will forward to the Content Server two critical pieces of information:

- HTTP_HOST: The host header that the browser sends, identifying the host as it appears to the user in their browser address bar.

- SERVER_PORT: The port the browser uses in connecting to the Content Server.

The browser-based full address is used for two critical pieces of functionality:

1. Automatic creation of URLs in the left-hand frame of the Trays layout for the Content Server. In particular, the left-frame mini-search requires a prediction of the full URL, not just the relative URL.

2. The secondary URL (the #xml-http... piece following the PDF URL) that does highlighting for PDF documents.

Without any additional configuration, the BrowserUrlPath component augments the functionality of certain variables, so if SERVER_PORT has the value 433, then the component assumes the protocol is HTTPS instead of HTTP. Likewise, if SERVER_PORT does not have the value 433, then the component assumes the browser issued the request using HTTP and not HTTPS. This enhancement allows both a SSL (HTTPS) and non-SSL web server (HTTP) to access the same Content Server.

This component also has special functionality for WebDAV access. The configuration entry WebDavBaseUrl is augmented so that its usage is dynamic (its host and protocol vary using the "absolute" path rules).

Caution:
The functionality for WebDAV access alters the behavior of CHECKOUT and OPEN functions on some Content Server pages, and alters some behavior in the Site Studio client.

4.8.2.2 Affected Idoc Script Variables and Functions

The BrowserUrlPath component overrides the computation of the following Idoc Script variables and functions:

- HttpBrowserFullCgiPath

- HttpWebRoot

- HttpCgiPath

- HttpAdminCgiPath

- HttpImagesRoot

- proxiedCgiWebUrl

- proxiedBrowserFullCgiWebUrl

The BrowserUrlPath component adds computation for the following variables:

- HttpBrowserFullWebRoot: Defines the full URL path to the Web root of the current Content Server using values supplied from the user's current browser's address bar. This variable is similar to HttpBrowserFullCgiPath except it is for the Web root instead.

- HttpAbsoluteWebRoot: Defines the universal full URL path to the web root of the current Content Server. It can have a different protocol or host name than the path in HttpBrowerFullWebRoot. For example, if the user specifies an IP address for the host name, the HttpBrowserFullWebRoot variable might pick up the IP address, but the HttpAbsoluteWebRoot variable would ignore it and use the appropriate internally configured host name.

- HttpAbsoluteCgiPath: Defines the universal full dynamic root URL for the current Content Server. This is the path that executes the plug-in code in the web server that makes calls for dynamic content from the Content Server. It can have a different protocol or host name than the path in HttpBrowserFullCgiPath. For example, if the user specifies an IP address for the host name, the HttpBrowserFullCgiPath variable might pick up the IP address, but the HttpAbsoluteCgiPath variable would ignore it and use the appropriately internally configured host name.

In the case of the browser path variables HttpBrowserFullCgiPath and HttpBrowserFullWebRoot, the implementation code determines what the user is currently using for protocol (HTTP versus HTTPS), port number, and host name in the browser. It bases this determination on what the web server receives in its request.

4.8.2.3 Determining the URL Path

The BrowserUrlPath component supports the following configuration entries for guessing the URL path as the browser determines it:

- HttpIgnoreWebServerInternalPortNumber: When set to true, this disables the use of the SERVER_PORT parameter. This entry is useful in a load balancing scenario where SERVER_PORT is not the port used by the browser, but is the port used by the load balancer to communicate with the web server. Enabling this entry will make it impossible (without the BrowserUrlPath component) for the Content Server to determine which port the browser used to access the web server. Without additional BrowserUrlPath configuration, this variable makes it impossible to both support an SSL and non-SSL address to the same Content Server. Using this variable prevents a load balancing configuration problem in which the load balancing server is using a different port number than the internal web server actually delivering the response to the request.

- HttpIgnoreServerNameForHostName: When set to true, this disables the fallback logic where if the HTTP_HOST parameter is missing, the Content Server will typically look for the parameter SERVER_NAME (the web server's self identification).

- HttpBrowserSSLPort: Only use this configuration entry if the SERVER_PORT entry is forwarded to the web server that communicates to the Content Server. This entry is used to decide whether a request is HTTPS or HTTP by comparing it with the SERVER_PORT parameter. The default SERVER_PORT value is 443. If you use HTTPS, but use a port other than 443, you must use this entry to set the expected HTTPS port number.

- HttpBrowserUseIsSslCookie: If you want to look in the cookie to see if it indicates whether to use SSL or not, set this entry to true.

- HttpBrowserIsSslCookieName: Only use this entry if the HttpBrowserUseIsSslCookie entry is enabled. Set the entry to the name of the cookie used to determine whether the server believes the browser is using SSL or not. The default is the cookie name UseSSL. The value of the cookie can be 1 or 0 (zero). If a cookie with this name is present, then it will supersede other rules for determining whether to use SSL.

- HttpBrowserUseHostAddressCookie: When set to true, this specifies to use a cookie to determine the full host name of the browser (the part between the protocol and the relative web address).

- HttpBrowserHostAddressCookieName: This entry is enabled only if HttpBrowserUseHostAddressCookie is enabled. Use this entry to specify the name of the cookie used to determine what the server believes is the browser's current host name. The host name part of the protocol can include the port number. For example, HttpbrowserHostAddressCookieName=myhost:81 would specify the host myhost using the webport 81. If you do use this cookie, then it is unlikely that you need to enable HttpBrowserUseIsSslCookie, because if you use myhost:433, that will translate to https://myhost/%rest-of-url%.

4.8.2.4 Changing Absolute Full Path Computation

The BrowserUrlPath component supports the following configuration entries for changing how the absolute full path is computed. This is useful for e-mail, where it is better to use a specific host name and protocol, even if the browser shows a different URL. This path is considered the absolute or universal path.

- HttpBrowserAbsoluteUrlHasRelativeSSL: When set to true, this variable allows a URL computed on the Content Info page to change from HTTP to HTTPS (or the other way if UseSSL is enabled in the config.cfg file), depending on what the Content Server determines as the current use in the user's browser. The change between HTTP and HTTPS also changes the computation of the URL for creating the e-mail body for the "email to" links. This configuration has no effect on automatically generated e-mail.

- HttpBrowserAlternateWebAddress: Specifies an alternate absolute host web address (host name plus optional port number). For example, HttpBrowserAlternateWebAddresss=host_name:447. This web address is used for the absolute path computation if the current SSL choice is different from the default for the Content Server. This configuration has no effect on automatically generated e-mail.

- HttpBrowserAbsoluteUrlUsesBrowserPath: When set to true, if browser path information can be computed, then the absolute path will use the browser path. This essentially turns off the absolute path except for background activities (such as sending notification e-mail).

4.8.2.5 Changing Administration Path Computation

The BrowserUrlPath component supports the following configuration entries for changing how paths are computed for Administration tray or top menu links. For example, the variable HttpAdminCgiPath, which retrieves the Admin Server CGI as a relative URL to the Admin Server, computes an administration path.

- HttpBrowserAdminUsesAbsolutePath: When set to true, instead of using the browser-based path (which is the default with the BrowserUrlPath component), the absolute path is used as the basis for computing administration paths, except for the protocol that is dictated by the configuration variable HttpBrowserUseAdminSSL.

- HttpBrowserUseAdminSSL: This configuration entry is only relevant if the HttpBrowserAdminUsesAbsolutePath variable is set. When set to true, this variable dictates the protocol in the administration paths (HTTP or HTTPS) even if HttpBrowserAbsoluteUrlHasRelativeSSL is set. The default value of HttpBrowserUseAdminSSL is the opposite of UseSSL. This allows the administration path to be nonstandard from the default URL constructions for all other paths. The variable HttpBrowserAlternateWebAddress, if set, can be used to also give the administration path a different web address in the case that HttpBrowserUseAdminSSL is set to the opposite of UseSSL.

For further information on variables and enabling the BrowserUrlPath component, see the Oracle Fusion Middleware Idoc Script Reference Guide and the Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite for your operating system.

4.8.3 Extended User Attributes

The Extended User Attributes component enables administrators to add extended security attributes to Content Server users. The extended security attributes are merged into pre-existing user attributes and enable additional flexibility in managing users. For example, roles and accounts attributes can be added to external LDAP users without needing to perform internal setup. Also, roles and accounts attributes can be added to users for a customized application separately from base user attributes.

The Extended User Attributes component is installed (enabled) by default with Content Server. Services installed for the Extended User Attributes component are described in the Oracle Fusion Middleware Services Reference Guide for Unversal Content Management.

This section covers the following Extended User Attributes topics:

- "ExtUserAttribInfo ResultSet"

- "Configuration Variable for Extended User Attributes"

In addition to these resources, there are added queries which can be used to gather data for extended user attributes. The queries can be viewed in the Component Wizard or by looking in the UCM_ORACLE_HOME/ucm/idc/components/ExtendedUserAttributes/resources/extendeduserattributes_query.htm file.

4.8.3.1 ExtUserAttribInfo ResultSet

ExtUserAttribInfo is the ResultSet used by the Content Server to handle extended user attributes. It is similar to the UserAttribInfo ResultSet used for handling regular user attributes, with some additional information.

This ResultSet has three columns. You can supply one attribute per row or multiple attributes on a single row (per application). The following columns are included:

- dUserName: The user whose attributes are being described.

- dApplication: The application to which those attributes are linked.

- AttributeInfo: The attribute information. This is a comma-separated entry consisting of three items:

- attribute type: usually either a role or account, depending on if a security group or account is being defined for the user

- attribute name: the title of the role or account

- attribute privilege: a definition of rights given to the user. Rights are defined according to UNIX conventions:

- 1: read permisson

- 2: write permission

- 4: delete permission

- 8: admin

For example, the entry role,contributor,3 gives the user permission to read and write in the contributor security group.

Multiple AttributeInfo entries can be added in a single row, separated by commas. For example, this entry adds two attributes into the AttributeInfo row: role,guest,15,account,\#all,15.

The following is an example of this ResultSet:

@ResultSet ExtUserAttribInfo
3
dUserName
dApplication
AttributeInfo
jsmith
appl
role,contributor,15
jsmith
app2
account,abc,15,account,xyz,15
@end

4.8.3.2 Configuration Variable for Extended User Attributes

The following configuration variable can be set in Content Server and is useful if you are working with default attributes:

- DefaultAttributesCacheTimeoutInSeconds: Defines how long the default attribute cache remains active (default = 600).

4.8.4 Filter Data Input

The Content Server can be customized to filter data input for illegal or corruptive HTML constructs by using the encodeHtml Idoc Script function and a filter hook to automatically scrub all input data for dangerous HTML constructions. The encodeHtml function can be applied to a specific string. The HtmlDataInputFilterLevel configuration variable can be used to apply a level of encoding to filter all data input to the Content Server.

This section covers the following topics:

- "encodeHtml Function"

- "HtmlDataInputFilterLevel Configuration Variable"

4.8.4.1 encodeHtml Function

The encodeHtml Idoc function can be used to filter data input for illegal or corrupted HTML constructs. The output is an encoded string. The encodeHtml function is applied by default to the discussions in the Threaded Discussions component.

The encodeHtml function is generally used at the exceptsafe or higher level of encoding because the HtmlDataInputFilterLevel configuration variable will already have been encoded as unsafe (assuming it uses the default configuration).

The encodeHtml function is defined as follows:

encodeHtml (string, rule, wordbreakrules)

- string: The string to encode.

- rule: The rule to apply when encoding HTML constructs. The following values are allowed:

- none: No conversion is done to HTML constructs.

- unsafe: Only well-known unsafe script tags are encoded. The list includes: script, applet, object, html, body, head, form, input, select, option, textarea.

- exceptsafe: Only well-known safe script tags are not encoded. The list includes: font, span, strong, p, b, i, br, a, img, hr, center, link, blockquote, bq, fn, note, tab, code, credit, del, dfn, em, h1, h2, h3, h4, h5, blink, s, small, sub, sup, tt, u, ins, kbd, q, person, samp, var, ul, li, math, over, left, right, text, above, below, bar, dot, ddot, hat, tilde, vec, sqrt, root, of, array, row, item.

- lfexceptsafe: (Recommended where extended comments are entered by a user and they want to preserve the line feed breaks of the original text.) Similar to exceptsafe, however, line feed (ASCII 10) characters are turned into HTML break tags (br). Line feeds inside of HTML tags are not turned into break tags. The following script tags that are safe with exceptsafe are not safe with lfexceptsafe: br, p, ul, li.

Except for the rule none, all the rules have special HTML comment handling. In particular, all HTML comments are allowed through the filter. However, when inside an HTML comment, all less than (<) and greater than (>) symbols are encoded. This does not apply to the HTML closing signature (-->). Also, if there is an unterminated comment, the encoding function appends the HTML comment close signature (-->).

Additionally, except for the rule none, any attribute value located inside a tag has any parenthesis encoded to %28 (for '(') or %29 (for ')'). Otherwise, if any character is escaped it is escaped using the XML (&xxxx;) type encoding.

wordbreakrules: This is an optional parameter that specifies if long strings without space characters are to be broken up and what maximum word size to apply. Either the string wordbreak or nowordbreak can be specified. This parameter can be used with any of the encodeHtml rules. The default is to turn on wordbreak if the rule lfexceptsafe is specified, and to use a maxlinelength of 120 characters.

The additional parameter maxlinelength=xxx can be used with the wordbreak parameter to specify a desired maximum line length. For example:

encodeHtml ("exceptsafe", "<bad> text", "wordbreak, maxlinelength=80")

The wordbreak functionality is only usable by the encodeHtml function because the function is used for display and not applied before the data is stored.

For information about Idoc Script see the Oracle Fusion Middleware Idoc Script Reference Guide.

4.8.4.2 HtmlDataInputFilterLevel Configuration Variable

The HtmlDataInputFilterLevel configuration variable can be used to apply a level of encoding to filter all input data to the Content Server for bad HTML constructions. The HtmlDataInputEncodingRulesForSpecialFields table in the std_resources.htm file is used for special case encoding rules and may override this configuration entry for certain parameters.

Note that if you change the HtmlDataInputFilterLevel value, you must restart the Content Server.

Using the HtmlDataInputFilterLevel variable has no effect on the behavior of the Idoc Script encodeHtml function.

You can set the HtmlDataInputFilterLevel configuration variable to the following values:

- none: (Not recommended.) All filtering is turned off.

- unsafe: (Default. Recommended.) Protects against bad HTML constructions. Examples of bad constructions include: script, applet, object, html, body, head, form, input, select, option, textarea.

- exceptsafe: (Not recommended.) Allows only well known safe constructions through the filter. If exceptsafe is chosen, then the unsafe option will be applied to requests using GET style requests. Doing a higher level of encoding on GET requests breaks Content Server operation because <$...$> and other tags are routinely passed in as part of the parameter data or URLs. The higher level of filtering is only applied to non-scriptable services (those services that are usually called with POST).
Examples of well known safe constructions include: font, span, strong, p, b, i, br, a, img, hr, center, link, blockquote, bq, fn, note, tab, code, credit, del, dfn, em, h1, h2, h3, h4, h5, blink, s, small, sub, sup, tt, u, ins, kbd, q, person, samp, var, ul, li, math, over, left, right, text, above, below, bar, dot, ddot, hat, tilde, vec, sqrt, root, of, array, row, item.

See the encodeHtml Function rule description for information about HTML comment handling, which also applies to HtmlDataInputFilterLevel configuration values.

The value lfexceptsafe is not supported for the HtmlDataInputFilterLevel configuration variable. It is only supported with the encodeHtml function.

5 Working With Components

This chapter describes how to use the Component Wizard to create new Content Server components, how to use the Component Manager to administer and enable/disable system and custom Content Server components, and how to use a command-line tool to install, enable, and disable Content Server components.

The following topics are covered:

- "About Components"

- "Using the Component Manager"

- "Enabling and Disabling a Component"

- "Viewing Information about a Component"

- "Uploading a Component"

- "Downloading a Component"

- "Using the Component Wizard"

- "Creating a Component"

- "Using the Command Line"

5.1 About Components

A component is a functional unit that can be plugged into Content Server to provide additional features or to modify existing functionality. The primary use for components is to modify the user interface of existing pages and to alter behavior of existing services. Standard components are provided with Content Server, and additional components can be acquired from the Oracle Technology Network. Administrators and developers can create their own custom components for their sites.

Note:
For detailed information on the structure and use of components, see the Oracle Fusion Middleware Developer's Guide for Content Server.

Table 5-1 lists standard Content Server components. Not all components are installed or enabled by default.

Table 5-1 Oracle Content Server Components

Component

Description

ActiveDirectoryLdapComponent

Enables Content Server to authenticate users against an Active Directory server via LDAP. The provider also pulls in all group membership and specified user metadata from Active Directory.

AddCCToArchiveCheckin

Adds Content Categorizer to the CHECKIN_NEW and CHECKIN_UNIVERSAL services by overriding the standard Content Server service scripts, such that Content Categorizer is called to provide values for the various metadata fields before the actual checkin takes place.

AddCCToNewCheckin

Adds Content Categorizer to the CHECKIN_NEW and CHECKIN_UNIVERSAL services by overriding the standard Content Server service scripts, such that Content Categorizer is called to provide values for the various metadata fields before the actual checkin takes place.

BpelIntegration

Adds the ability to interact with Business Process Execution Language (BPEL) Process Manager from within Content Server workflows. Administrators can configure Content Server workflows to initiate a deployed process on the BPEL server.

BrowserUrlPath

Changes the computation of the Content Server variable HttpBrowserFullCgiPath and the function proxiedBrowserFullCgiWebUrl() so that they are no longer hardwired to a particular protocol. If the request comes in on port 443 (the SSL port), then the variable or function returns a result with HTTPS as the protocol. Otherwise, the variable or function returns a result with HTTP as the protocol.

CleanContent

Contains clean content libraries and generates descriptions of the documents for use by the DesktopTag component.

ContentFolios

Provides a quick and effective way to assemble, track, and access logical groupings of multiple content items from within the secure environment of Content Server. For example, this component can be used to set up a new project that requires a virtual place to assemble all relevant content items in a particular hierarchy, whenever they are checked in, with restricted access to particular areas of the hierarchy.

ContentAccess

Performs standard "in place" conversion and filtering for Content Server. It is used to create HTML renderings of native content, extract text for full text indexing, and extract links for link reference management.

ContentBasket

Enables users to select renditions of content items and place them in a personal storage space called the Content Basket. When this component is installed independently, renditions can be selected and placed in the Content Basket from either the Search Result or Content Information pages via the Actions dropdown on either page. Users can choose either native file or web-viewable renditions. When using Image Manager or Video Manager, additional rendition types can be selected for the Content Basket via Actions options on the Rendition Information page.

Note: the ContentBasket component is required when using either Image Manager or Video Manager.

ContentCategorizer

Suggests metadata values for documents being checked into Content Server, and it can be used to recategorize the metadata of documents that are already in Content Server. Metadata values are determined according to search rules provided by the administrator.

ContentTracker

Monitors activity on a Content Server instance and records selected details of those activities. It then generates reports that can help administrators understand the ways in which the system is being used.

ContentTrackerReports

Reports on the data generated by the Content Tracker component.

DAMConverter

This Inbound Refinery component is the primary component for the Digital Asset Management feature.

DBSearchContainsOpSupport

Adds support of hasAsWord(Contains) operator to DATABASE and DATABASEFULLTEXT on SQL Server, Oracle, and DB2 databases.

DamConverterSupport

Enables Inbound Refinery to create multiple packaged (zipped) renditions of a checked-in graphic file. The ZipRenditionManagement component can be used to access the renditions created by the refinery.

DesktopIntegrationSuite

Provides a set of embedded applications that help administrators seamlessly integrate the desktop experience with Content Server. It provides convenient access to Content Server from Microsoft Windows Explorer, desktop applications like Microsoft Word and Excel, and e-mail clients like Microsoft Outlook and Lotus Notes.

DesktopTag

Modifies documents supported by the CleanContent component by maintaining a set of custom properties in the documents. These properties are used by the Desktop Integration Suite Microsoft Office integrations to aid in using files with Content Server.

DigitalAssetManager

Enables users to define and provide images and videos in specified formats and sizes for download. The component creates multiple formats of digital assets automatically when an image or video is checked into Content Server, and lists the formats under one content ID.

DynamicConverter

Converts a document into a Web page for everyone to see without use of the application used to create that document.

EmailMetadata

Extracts information from Microsoft Outlook messages (MSG) and Internet Mail Messages (EML), and populates e-mail specific fields in Oracle Content Server. This process occurs when users check in files using the Oracle Content Server Folders functionality in Microsoft Outlook, Lotus Notes, or Windows Explorer. This also occurs when checking in MSG or EML files using the Web browser interface.

ExtranetLook

Enables customization of the out-of-box Oracle UCM look and feel. This component has two parts: one part enables customization of cookie-based login forms and pages; the other part modifies the error and challenge pages issued by the Web server.

FileStoreProvider

Enables Content Server more control over how files are stored. Files can either be stored in the database or on the file system. The component has extension options where you can write components that store files in other types of storage repositories. When files are stored on the file system, the component allows additional flexibility in path computations. For Web-viewable paths, the types of paths allowed are restricted.

FolderStructureArchive

Enables administrators to configure a Content Server Archive to archive the folder structure as well as its associated content. The structure of the folders is archived using database table replication.

Folders_g

An optional component that provides a hierarchical folder interface to content in Content Server in the form of "virtual folders" (also called "hierarchical folders").

FormEditor

Provides the ability to use cross-platform browsers to create Content Server hcsf forms.

HTMLConverter

Enables Inbound Refinery to convert native Microsoft Office formats (Word, Excel, PowerPoint and Visio) to HTML using the Office application.

HTMLConverterSupport

Enables Inbound Refinery to convert native Microsoft Office formats (Word, Excel, PowerPoint and Visio) to HTML using the Office application.

InboundRefinerySupport

Enables Content Server to use Inbound Refinery for the conversion of files. Without this component Content Server cannot use Inbound Refinery.

LinkManager8

Extracts URL links of indexed documents, evaluates, filters and parses the URLs according to a pattern engine, and then stores the results in a database table. Because the link extraction occurs during the indexing cycle, only the links of released documents are managed.

MSOfficeHtmlConverterSupport

Enables Content Server and Inbound Refinery to convert select Microsoft Office formats to HTML using the native application.

NativeOsUtils

(Required) Provides the native JNI calls needed by Content Server. Content Server can run without this component enabled, but it loses some functionality. The two noticeable degradations are as follows:

- In schema publishing, all files are rewritten instead of using hard links to have new files link back to existing files when the content does not change.

- When a component is installed that has native executables, the executable bit on the files is not toggled properly. This can affect components such as ContentAccess.

OpenOfficeConversion

Enables Inbound Refinery to integrate with OpenOffice.

OracleQueryOptimizer

Aids in tuning queries against the Oracle database by allowing query hints to be added to ensure that the best execution plan is used.

PDFExportConverter

Enables Inbound Refinery to use Oracle OutsideIn PDF Export to convert native formats directly to PDF without the use of any third-party tools.

PDFWatermark

Enables watermarks to be applied to PDF files generated by the Inbound Refinery PDFConverter component and returned to the content server. PDF files already residing on the content server also can be watermarked. Dynamic watermarks are generated on-the-fly and can contain variable information.

SESCrawlerExport

Adds functionality to the content server to allow it to be searched using Oracle Secure Enterprise Search.

SelectivelyRefineAndIndex

Provides system administrators with more control over what conversion type to use for checked-in content items. Administrators also can determine which content items should have only metadata indexing or both full-text and metadata indexing.

SiebelEcmIntegration

Part of Siebel Adapter for UCM that enables Siebel CRM users to store and retrieve attachments stored in a content server repository.

SiebelIntegrationSearchDisplay

Displays Universal Content Management (UCM) documents as managed attachments to Siebel entities in an iFrame within the Siebel application.

SiteStudio

A powerful, flexible Web development application suite that offers a comprehensive approach to designing, building, and maintaining enterprise-scale Web sites. It offers both Web site creation and content management.

ThreadedDiscussions

Enables the ability to create discussion documents about another document. It takes any content item and adds "_d" to the document ID to create a new hcsp style document that is focused on discussion about the originating document.

TiffConverter

Enables Content Server and Inbound Refinery to integrate with CVista PDF Compressor. The component defines the TIFFConversion conversion and steps that are required by the conversion.

TiffConverterSupport

Enables Content Server and Inbound Refinery to convert tiff files to searchable PDF files.

WinNativeConverter

Extends the PDFConverter feature and requires the Refinery feature. It enables Inbound Refinery to convert native files to a postscript with either the native application or OutsideInX and convert postscript to PDF.

XMLConverter

Enables Inbound Refinery to produce FlexionDoc and SearchML styled XML as the primary Web viewable or as renditions.

XMLConverterSupport

Enables Content Server and Inbound Refinery to convert various formats to FlexionDoc or SearchML as either the primary Web rendition or an additional rendition. It also enables Content Server and Inbound Refinery to preform XSLT transformations.

YahooUserInterfaceLibrary

(Required) Provides a wrapper for the Yahoo! User Interface Library (YUI) available under the BSD license. Content Server adopted the YUI library for its user interface implementation because of its ability to implement folder move operations (move an item from one folder to another) and for its support of Accessibility (specifically keyboard operations). The YUI library is also used for its calendar control and its ability to support popup choice lists in type-ahead fields.

ZipRenditionManagement

Enables users to create and edit additional attachment files that are maintained in a zip file. It does this by creating a new rendition type 'Z' with description "Zipped Attachments". This component is used as part of Digital Asset Management.

5.2 Using the Component Manager

This section describes the following tasks you can perform with the Component Manager to manage system and custom components:

- "Enabling and Disabling a Component"

- "Viewing Information about a Component"

- "Uploading a Component"

- "Downloading a Component"

5.2.1 Enabling and Disabling a Component

Use the following procedure to enable or disable a component from the Component Manager:

1. Open the Admin Server Page.
The Component Manager Page is displayed.

2. Click advanced component manager to display the Advanced Component Manager Page.

3. Select the component to enable or disable.

4. Click the Update button.

5. Restart the content server instance. See "Restarting Content Server"
The content server restarts, and the component is now enabled or disabled.

6. Navigate to the pages affected by the component to ensure that the addition or removal of the customization is working as you expected.

Note:
When the content server is started, enabled components are loaded in the order shown in the Components list.

5.2.2 Viewing Information about a Component

Use the following procedure to view descriptive information about a component on your system:

1. Open the Admin Server Page.
The Component Manager Page is displayed.

2. Click advanced component manager to view the Advanced Component Manager Page.

3. Click a component name in either the list of Enabled or Disabled components.
Information about the component is displayed in a pane next to the list, including component name, tags, location, feature extensions, class path, and so forth.

5.2.3 Uploading a Component

Use the following procedure to upload a component zip file using the Component Manager:

Tip:
Components can also be uploaded (unpackaged) using the Component Wizard. See "Using the Component Wizard" for details.

1. Open the Admin Server Page.
The Component Manager Page is displayed.

2. Click advanced component manager to view the Advanced Component Manager Page.

3. Click the Browse button next to the Install New Component field.

4. Navigate to and select the component zip file.

5. Click Open.
The path and file name appears in the Install New Component field.

6. Click Upload.
The component files are unpackaged on the content server, and the name of the component appears in the Disabled Components list.

Note:
Uploading a component does not enable it. See "Enabling and Disabling a Component" for details.

7. If you are having difficulty uploading the component, check the content server output messages by clicking the View Admin Output link in the sidebar menu. The Admin Server Output Page is displayed where you can verify the recent actions.

5.2.4 Downloading a Component

A component cannot be downloaded unless it meets these requirements:

- The component must exist outside of the ECM_ORACLE_HOME/ucm/idc/system directory. This excludes all shipped components unless a patch has been uploaded to a component. The component must have a zip file with the appropriate name, located inside the component directory. Usually this occurs only when the component has been uploaded or installed manually.

Use the following procedure to package a component as a component zip file:

1. Open the Admin Server Page.
The Component Manager Page is displayed.

2. Click advanced component manager to view the Advanced Component Manager Page.

3. Select the component to be packaged from the Download Component list.

4. Click Download.
The File Download screen is displayed.

5. Select the Save this file to disk option and click OK.
The Save As screen is displayed.

6. Navigate to the directory where you want to save the component zip file.

7. Change the name of the component zip file as necessary.

8. Click Save.
The component is saved as a component zip file.

5.3 Using the Component Wizard

This section describes how to use the Component Wizard to create components. It contains the following major sections:

- "Component Wizard Overview"

- "Creating a Component"

- "Additional Component Wizard Tasks"

Note:
When using the Component Wizard with Red Hat Linux ES 3, set UseCustomModaling=FALSE in your DomainHome/ucm/cs/bin/intradoc.cfg file. This variable allows a modal dialog to lock only one frame, instead of all frames. Setting the variable in the intradoc.cfg file ensures that other applets are unaffected by this action. See the Oracle Fusion Middleware Idoc Script Reference Guide for details on its usage.

5.3.1 Component Wizard Overview

The following steps provide a general overview on using the Component Wizard to create a custom component. The screens used to create this component are described in detail in Appendix A, "User Interface" and are referenced throughout the text.

1. Launch the Component Wizard.
The Component Wizard Main Screen is displayed or the Component List Screen is displayed if other components are already available.

2. If the Component List screen is displayed, select Add. Otherwise, select Options, then Add on the Component Wizard Main Screen.

The Add Component Screen is displayed.

3. Make sure the Create New Component option is selected and enter the name of the new component.

4. Click OK.
A confirmation screen is displayed.

5. Click OK.
The Component List screen closes, and the new component is opened in the Component Wizard screen, as indicated by its name in the Location field.

5.3.1.1 Working with Java Code

If your new component includes Java code, you can use the Java Code tab of the Component Wizard to view the contents of the ClassAliases table and the Filters table.

You can also remove classes and filters from the component glue file, although the file that is associated with the class or filter will not be deleted from your system. Select the class or filter and click the associated Remove button to remove it from the list.

5.3.1.2 Editing the Readme File

The Component Wizard provides a convenient way to create a Readme file for your custom component. Use the following procedure to edit a Readme file:

1. Open the component in the Component Wizard.

2. Select Edit Readme File from Options.
The text editor opens a readme.txt file, with the name of the component entered on the first line.

3. Enter text to document your component.

4. Save and close the file.
The readme.txt file is saved in the same directory as the component definition file, and will be included as a ComponentExtra entry if you use the Component Wizard to build a component zip file.

5.3.2 Creating a Component

Use the following procedure to create a component using the Component Wizard:

1. Launch the Component Wizard.
For more information, see "Running Administration Applications in Standalone Mode".

2. The Component Wizard Main Screen is displayed, or the Component List Screen is displayed if other components are already available. The Component List screen shows all components and their status (enabled or disabled).

Note:
If no components are installed, the Component List screen does not appear.

3. If the Component List screen is displayed, select Add. Otherwise, select Options, then Add on the Component Wizard Main Screen.
The Add Component screen is displayed.

4. Enter a name for the new component in the Name field.

5. Accept the default directory (custom), or enter a new location for the component. This can be either an absolute path or can be a path relative to the Content Server install directory.

6. To use an existing component as a starting point, select the Copy Existing check box, click Browse, and navigate to and select the definition (glue) file (component_name.hda) for the component.

7. Click OK.
A new component definition (glue) file is created. If you copied an existing component, the resource files are renamed with the new component name and copied to the new component directory.

8. Add and edit custom resources and other files as necessary as described in these sections:

- Creating an Environment Resource

- Creating a Template Resource

- Creating a Query Resource

- Creating a Service Resource

- Creating an HTML Include

- Creating a String Resource

- Creating a Dynamic Table Resource

- Creating a Static Table Resource

5.3.2.1 Creating an Environment Resource

An environment resource defines configuration variables, either by creating new variables or replacing the value in existing variables.

Follow these steps to create an environment resource:

1. Make sure that the Resource Definition tab is selected on the Component Wizard Main Screen. Click Add.
The Add Resource Screen is displayed.

2. Select the Environment option.

3. Enter the file name for the resource file. The default file name is componentname_templates.hda.

- If a resource file has been created, you can add to the file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

- To create a new resource file with a different file name, enter the file name.

4. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

Note:
Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

5. Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.

6. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.
The file now appears in the Custom Resource Definition list.

Note:
If an HTML editor is not defined, select Configuration from Options in the Component Wizard main menu and enter the path and file name of the desired editor, or click Browse and navigate to the executable of the desired editor. See "Configuring the Default HTML Editor" for details.

After saving, the new environment resource is displayed on the Component Wizard screen.

5.3.2.2 Creating a Template Resource

A template resource file defines names, types, and locations of custom templates to be loaded for the component. Follow these steps to add a template page:

1. Make sure that the Resource Definition tab is selected on the Component Wizard Main Screen. Click Add.
The Add Resource Screen is displayed.

2. Select the Template option. The Add Template Table Information Screen is displayed.

3. Enter the file name for the resource file. The default file name is componentname_templates.hda.

- You can enter templates/ before the file name to create a new /templates directory in your component directory.

- If a template resource file has been created, you can append a new template table to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

- To create a new resource file with a different file name, enter the file name.

4. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

Note:
Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

5. Click Next.
The Add Template Table Information Screen is displayed.

6. Enter a name for the template table.

- It is a good idea to leave the name of the component as a prefix.

- Each template table in a component must have a unique name, even if the tables are in different resource files.

7. Select which standard table to merge the new template table into: either IntradocTemplates or SearchResultTemplates.

8. Click Next.
The Add/Edit Intradoc Template Screen is displayed.

9. To start with an existing template definition:

1. Click Select.
A list of commonly used templates is displayed.

2. Select the Show All check box to show the entire list of predefined templates.

3. Select a template from the list.

4. Click OK.
The template parameters are filled in.

Note:
You can also use an existing custom template file as a starting point. Select the Copy From check box, and navigate to and select the template file. The template parameters will not be filled in automatically, but you could select a standard template to fill in the fields before selecting the template file.

10. Edit the template parameters as necessary.

Note:
If you do not change the name of the template and this component is loaded last, the custom template will override the standard template and any other custom templates with the same name.

11. Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.

12. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.
The file now appears in the Custom Resource Definition list, and the template table appears in the Table Name list in the right pane.

5.3.2.3 Creating a Query Resource

A query resource defines SQL queries, which are used to manage information in the database. Queries are used with services to perform tasks such as adding, deleting, or retrieving data from the database.

Follow these steps to add a query:

1. On the Component Wizard Main Screen, click Add in the Resource Definition pane.
The Add Resource Screen is displayed.

2. Select the Query option.

3. Enter the file name for the resource file. The default file name is resources/componentname_query.htm.

- If a query resource file has been created with the default file name, the new default file name will have a number (1, 2, and so on) appended to it. You cannot append a query table to the existing default file unless you edit the resource file manually.

- If a query resource file has been created with a file name other than the default, you can append a new query table to the existing file.

- To create a new resource file with a different file name, enter the file name.

4. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

Note:
Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

5. Click Next.
The Add Query Table Information Screen is displayed.

6. Enter a name for the query table. It is a good idea to leave the name of the component as a prefix.

- If you are appending to an existing query resource file, you must enter a new table name. You cannot append a query definition to the existing table unless you edit the resource file manually.

7. Click Next.
The Add/Edit Query Screen is displayed.

8. To start with an existing query definition:

1. Click Select.
A list of predefined queries is displayed.

2. Select a query from the list.

3. Click OK.
The query expression and parameters are displayed and the Name field is filled in.

Note:
If you do not change the name of the query and this component is loaded last, the custom query will override the standard query and any other custom queries with the same name.

9. Edit the query expression and parameters as necessary.

- Parameters must appear in the Parameters list in the order they appear in the query expression. Use the Up and Down buttons to move the selected parameter.

- To add a parameter, click Add. Enter a parameter Name, select the parameter Type, and click OK.

- To edit a parameter type, select the parameter and click Edit. Select the parameter Type, and click OK.

- To remove a parameter, select the parameter and click Delete.

10. Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.

11. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.
The query resource file now appears in the Custom Resource Definition list, and the query table appears in the Table Name list in the right pane.

5.3.2.4 Creating a Service Resource

A service resource defines a function or procedure that is performed by the Content Server.

Use the following procedure to create a service resource using the Component Wizard.

1. In the Component Wizard, open the component the resource will be created for.

2. On the Resource Definition tab, click Add.
The Add Resource Screen is displayed.

3. Select the Service option.

4. Enter the file name for the resource file. The default file name is resources/componentname_service.htm.

- If a resource file has been created for services, you can append the new service table to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

- To create a new resource file with a different file name, enter the file name.

5. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

Note:
Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

6. Click Next.
The Add Service Table Information Screen is displayed.

7. Enter a name for the service table.

- It is a good idea to leave the name of the component as a prefix.

- Each service table in a component must have a unique name, even if the tables are in different resource files.

8. Click Next.
The Add/Edit Service Screen is displayed.

9. To start with an existing service definition:

1. Click Select.
A list of commonly used services is displayed.

2. Select the Show All check box to show the entire list of predefined services.

3. Select a service from the list.
To view a service's details, click Preview. The Preview Information for Service Screen is displayed. Use this screen to view information about the service and the service actions.

4. Click OK.
The service attributes and actions are filled in.

Note:
If you do not change the name of the service and this component is loaded last, the custom service will override the standard service and any other custom services with the same name.

10. Edit the service attributes and actions as necessary.

- Actions must appear in the Actions list in order of execution. Use the Up and Down buttons to move the selected action.

- To add an action, click Add. The Add/Edit Action Screen is displayed. Enter the action definition and click OK.

- To edit an action, select the action and click Edit. Modify the action definition and click OK.

- To remove an action, select the action and click Delete.

11. Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.

12. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.
The service resource file now appears in the Custom Resource Definition list, and the service table appears in the Table Name list in the right pane.

5.3.2.5 Creating an HTML Include

An HTML include is a piece of reusable code that is referenced from a placeholder in another file or from another location in the same file. An include resource defines pieces of code that are used to build the Content Server web pages. Includes are resolved by the Content Server each time a web page is assembled. For this reason, includes are sometimes called dynamic content resources.

Follow these steps to add an HTML include resource:

1. On the Component Wizard Main Screen in the Resource Definition section, click Add.
The Add Resource Screen is displayed.

2. Select the Resource - HTML Include/String option.

3. Enter the file name for the resource file. The default file name is componentname_resource.htm.

- If a resource file has been created for includes, strings, or static tables, or both, you can append the include to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

- To create a new resource file with a different file name, enter the file name.

4. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

Note:
Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

5. Click Next.

The Add/Edit HTML Resource Include/String Screen screen is displayed.

6. Select the Include option.

7. To start with the code from an existing HTML include:

1. Click Select.
A list of commonly used includes is displayed.

2. Select the Show All check box to show the entire list of predefined includes.

3. Select an include from the list.

4. Click OK.
The include code is displayed and the Name field is filled in.

Note:
If you do not change the name of the include and this component is loaded last, the custom include will override the standard include and any other custom includes with the same name.

8. Edit the include code as necessary.

9. Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.

10. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.
The resource file now appears in the Custom Resource Definition list, and the include appears in the Custom HTML Includes list.

5.3.2.6 Creating a String Resource

A string resource defines locale-sensitive text strings that are used in error messages and on Content Server web pages and applets.

Use the following procedure to create a string resource using the Component Wizard.

1. In the Component Wizard, open the component the resource will be created for.

2. On the Resource Definition tab, click Add.
The Add Resource Screen is displayed.

3. Select the Resource - HTML Include/String option.

4. Enter the file name for the resource file. The default file name is componentname_resource.htm.

- If a resource file has been created for includes, strings, or static tables, or both, you can append the include to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

- To create a new resource file with a different file name, enter the file name.

1. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

Note:
Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

2. Click Next.
The Add/Edit HTML Resource Include/String Screen is displayed.

3. Select the String option.

4. Enter the name of the string in the Name field (for example, myString.)

Note:
If you enter the name of an existing string and this component is loaded last, the custom string will override the standard string and any other custom strings with the same name.

5. Edit the string code as necessary (for example, This is my string text.)

6. Click Finish.
A dialog box asks if you want to launch the text editor to continue editing.

7. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.
The resource file now appears in the Custom Resource Definition list, and the string appears in the Custom Strings list.

5.3.2.7 Creating a Dynamic Table Resource

A dynamic table provides dynamic (often changed) content in table format to the content server.

Use the following procedure to create a dynamic table resource using the Component Wizard.

1. In the Component Wizard, open the component the resource will be created for.

2. On the Resource Definition tab, click Add.
The Add Resource Screen is displayed.

3. Select the Resource - Dynamic Table (Hda Format) option.

4. Enter the file name for the resource file. The default path and file name is resources/componentname_resource.hda.

- If a resource file has been created for dynamic tables, you can append the new table code to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

- To create a new resource file with a different file name, enter the file name.

5. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

Note:
Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

6. Click Next.
The Add Dynamic Resource Table Information Screen is displayed.

7. Enter a name for the dynamic table. It is a good idea to leave the name of the component as a prefix.

8. To merge the new table with an existing table, select the Merge To check box and select a table from the list.

9. Click Finish.

- If you selected a table to merge to, a dialog box asks if you want to launch the text editor to continue editing.

- If you did not select a table to merge to, the Column Information Screen is displayed.

1. Enter a column name in the Column Name field.

2. Click Insert. Repeat these steps until all of the table columns have been entered.

3. Click OK.
A dialog box asks if you want to launch the text editor to continue editing.

10. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.
The resource file now appears in the Custom Resource Definition list, and the table appears in the right pane of the Resource Definition tab.

5.3.2.8 Creating a Static Table Resource

Use the following procedure to create a static table resource using the Component Wizard.

1. In the Component Wizard, open the component the resource will be created for.

2. On the Resource Definition tab, click Add.
The Add Resource Screen is displayed.

3. Select the Resource - Static Table (HTML Format) option.

4. Enter the file name for the resource file. The default file name is componentname_resource.htm.

- If a resource file has been created for static tables, includes, or strings, or both, you can append the static table code to the existing file by selecting the file name. Any changes you make to the load order now will apply to the entire resource file.

- To create a new resource file with a different file name, enter the file name.

5. If you want the new resource file to be loaded in a particular order, enter the number in the Load Order field.

Note:
Unless you have a particular reason for the resource file to be loaded after other resources, you should leave the load order set to 1.

6. Click Next.
The Add Static Resource Table Information Screen is displayed.

7. Enter a name for the static table. It is a good idea to leave the name of the component as a prefix.

8. To merge the new table with an existing table, select the Merge To check box and select a table from the list.

9. Click Finish.

- If you selected a table to merge to, a dialog box asks if you want to launch the text editor to continue editing.

- If you did not select a table to merge to, the Column Information Screen is displayed.

1. Enter a column name in the Column Name field.

2. Click Insert.

3. Repeat steps a and b until all of the table columns have been entered.

4. Click OK.

A dialog box asks if you want to launch the text editor to continue editing.

10. Click Yes to open the resource file in the text editor. Click No to return to the Component Wizard.
The resource file now appears in the Custom Resource Definition list, and the table appears in the Resource Tables list.

5.3.2.9 Enabling the Component

After creating a component, you should enable it and test it.

- In the Component Wizard Main Screen, from the Options menu select Enable.

- Restart the Content Server.

- Test the newly created component.

5.3.3 Additional Component Wizard Tasks

In addition to creating custom components, you can use the Component Wizard to build zip files of your components and create custom installation parameters.

- "Building a Component Zip File"

- "Working With Installation Parameters"

- "Enabling and Disabling a Component"

- "Removing a Component"

- "Opening a Component"

- "Configuring the Default HTML Editor"

- "Unpackaging a Component"

- "Adding an Existing Component"

5.3.3.1 Building a Component Zip File

The Build function of the Component Wizard enables you to build a component zip file (or package), which can then be saved as a backup or unpackaged to deploy the component on other content servers.

Use the following procedure to build a component zip file:

1. Open the component in the Component Wizard.

2. Select Build Settings from the Build menu.
The Build Settings Screen is displayed.

A Component entry for the definition (glue) file and a ComponentExtra entry for a readme.txt file are created automatically. You should not remove the glue file entry, but you can delete the readme.txt entry.

3. Click Add.
The Add screen is displayed (Add Screen).

4. Select an Entry Type.

5. In the Sub Directory or File field, enter the location of the files for the selected entry type.

- For the Component entry type, this setting is the file name for the glue file.

- For other entry types, enter a path to select all files in a particular directory, or enter a path and file name to select an individual file.

- The location should be a path relative to the DomainHome/custom/ directory. You can use an absolute path (such as C:/oracle/custom/my_component/), but then the component can only be installed on content servers with the same installation directory path.

Note:
Always use forward slashes in the path.

6. Continue adding entry types and specifying the subdirectories until all of the files of your component are included.

7. Click OK.

8. Select Build from the Build menu.
The Main Build Screen is displayed.

9. Click OK.
The Component Wizard builds the component zip file in the DomainHome/custom/component_name/ directory.

5.3.3.2 Working With Installation Parameters

The Install/Uninstall Settings tab is used to create customized installation components that can include preference data parameters. These parameters can be user prompts and messages. Depending on how they are defined, the prompts and messages are displayed during the installation processes. These custom installation parameters allow the component author to ask for information from users before the component is installed.

To define custom installation parameters for a component:

1. In the Component List Screen, select the component that will have custom installation parameters defined.

2. Click Open.

3. Select the Install/Uninstall Settings tab on the Add/Edit Preference Screen and select the appropriate check boxes:

- Has Install/Uninstall Filter

- Has Install Strings

Generally, both options will be used to create the desired installation parameters.

4. Click the Launch Editor for the Install/Uninstall Filter option to open a Java code template file. Edit the existing code and include additional Java code to the template as necessary to create the filter procedures.
Each filter procedure will run once during the component installation or uninstall procedure. The values of user responses are saved in the installation configuration (install.cfg and config.cfg) files. See the Oracle Fusion Middleware Developer's Guide for Content Server for more information.

5. Save and close the Install/Uninstall Filter Java code file.

6. Click the Add button on the Preference Data Setup pane to open the Add/Edit Preference Screen.

7. Click the Launch Editor for the Install Strings option to open a Java code template file. Edit the existing code and include additional Java code to the template as necessary to define the set up prompts or messages.
Keep both the Add Preference screen and the Install Strings HTML template open to use simultaneously. Complete the fields on the Add Preference screen as necessary. Add the actual message or prompt text to the Install Strings HTML.

8. Save and close the Install Strings Java code file.

9. Open the Build Settings Screen by selecting Build Settings from the Build menu.

10. Complete the fields on the Build Settings screen as necessary.

11. If components have been specified to be included in the component zip file, they will need to be added as component extras using the Add Screen.
Click the Add button to open the Add screen. Add each component individually.

12. Click OK.

13. If necessary, add more components to the zip file as component extras.

14. On the Build Settings screen, click OK to create the component zip file.

The zip file can be shipped to clients and can be installed using either the Component Wizard or the Component Manager within the content server.

5.3.3.3 Enabling and Disabling a Component

Use one of the following procedures to enable or disable a component from the Component Wizard:

Tip:
Components can also be enabled and disabled using the Component Manager.

5.3.3.3.1 Option 1

1. Open the component in the Component Wizard.

2. In the Component Wizard Main Screen, from the Options menu select Enable or select Disable.

3. Restart the content server.
The component is now enabled or disabled.

4. Navigate to the pages affected by the component to ensure that the addition or removal of the customization is working as you expected.

5.3.3.3.2 Option 2

1. Use either of the following methods to display the Component List Screen:

- Start the Component Wizard.

- In the Component Wizard Main Screen, from the Options menu, select Open.

2. Select the component to be enabled or disabled.

3. Click Enable or Disable.

4. Restart the content server.
The component is now enabled or disabled.

5. Navigate to the pages affected by the component to ensure that the addition or removal of the customization is working as you expected.

5.3.3.4 Removing a Component

Use the following procedure to remove a component from the content server:

Note:
Removing a component means that the content server no longer recognizes the component, but the component files are not deleted from the file system.

1. Disable the component you want to remove.

2. If the component to be removed is open in the Component Wizard, open a different component or close and restart the Component Wizard. (A component cannot be removed if it is open.)

3. To display the Component List Screen:

- Start the Component Wizard

- Select Open from Options in the Component Wizard Main Screen

4. Select the component to be removed from the Component List Screen.

5. Click Remove.
A confirmation screen is displayed.

6. Click Yes.
The component no longer appears in the Component List.

5.3.3.5 Opening a Component

Use the following procedure to open a component that has already been added to the Content Server:

1. To display the Component List Screen:

- Start the Component Wizard

- Select Open from Options in the Component Wizard Main Screen

2. Select the component to be opened from the Component List Screen.

3. Click Open.
The component resources are shown in the Custom Resource Definition list on the Component Wizard Main Screen.

5.3.3.6 Configuring the Default HTML Editor

You can edit text-based component files directly from the Component Wizard by launching the HTML editor.

- For Windows, Microsoft WordPad (wordpad.exe) is the default.

- For UNIX, vi is the default.

Important:
Specify a text editor (such as WordPad) rather than a graphical HTML editor (such as FrontPage). Graphical editors can insert or change HTML tags and might cause Idoc Script tags to be converted into a string of characters that will not be recognized by the content server.

Use the following procedure to define the default HTML editor:

1. Display the Component Wizard Main Screen.

2. From the Options menu, select Configuration.
The Component Configuration Screen is displayed.

3. Click Browse.

4. Navigate to and select the executable file for the HTML editor you want to use.

5. Click Open.

6. Click OK.
When you click any Launch Editor button in the Component Wizard, the file will open in the selected program.

5.3.3.7 Unpackaging a Component

Use the following procedure to unpackage a component Zip file:

Note:
If you unpackage a component with the same name as an existing component on the content server, the older component will be zipped and copied to the DomainHome/ucm/cs/bin/ directory, with a filename beginning with backup and ending with a time stamp (such as backup1008968718221.zip).

1. Use either of the following methods to display the Install Screen:

- In the Component Wizard Main Screen, from the Options menu, select Install.

- From the Component List Screen, click Install.

2. Click Select.
The Zip File Path screen is displayed.

3. Navigate to and select the component zip file.

4. Click Open.
The contents of the component zip file are listed on the Unpackage screen.

5. Click OK.
The component files are copied to the correct locations (there might be a short delay while the files are unzipped), the Unpackage screen closes, and the component resources are shown in the Custom Resource Definition list on the Component Wizard Main Screen. The component is also added to the Component List.

Note:
Unpackaging a component does not enable it. See "Enabling and Disabling a Component".

5.3.3.8 Adding an Existing Component

Use the following procedure to add an existing unpackaged component to the content server:

1. Use either of the following methods to display the Add Component Screen:

- In the Component Wizard Main Screen, from the Options menu, select Add.

- From the Component List Screen, click Add.

2. Select the Use Existing Component option.

3. Click Browse.

4. Navigate to and select the component definition (hda) file (components.hda).

5. Click Open.
The path and file name are displayed in the FilePath field.

6. Click OK.
The component resources are shown in the Custom Resource Definition list on the Component Wizard Main Screen. The component is also added to the Component List.

Note:
Adding an existing component does not enable it.

5.4 Using the Command Line

The ComponentTool component enables administrators to use a command line to install, enable, and disable components. This component is installed (enabled) with Content Server.

When Oracle UCM is deployed, the ComponentTool launcher is installed by default for UNIX and Windows. The executable is located in the DomainHome/ucm/cs/bin/ directory.

UNIX

CompTool

Windows

ComponentTool.exe

Component Tool supports the commands listed in Table 5-2.

Table 5-2 ComponentTool Commands

Task

Command

Install a component (also automatically enables the component)

ComponentTool --install path/component_name

Enable a component

ComponentTool --enable component_name

Enable a component

ComponentTool --disable component_name

List enabled components

ComponentTool --list-enabled

List disabled components

ComponentTool --list-disabled

List all components

ComponentTool --list

Access ComponentTool help

ComponentTool --help

6 Managing Search Tools

This chapter covers the following topic:

- "OracleTextSearch"

- "Oracle Secure Enterprise Search"

6.1 OracleTextSearch

If you have a license to use OracleTextSearch (in Oracle Database 11g), the OracleTextSearch component enables the use of this technology as the primary full-text search engine for Oracle Universal Content Management (Oracle UCM). The OracleTextSearch component enables use of Oracle Text 11g as the primary full-text search engine for Oracle Universal Content Management (Oracle UCM). Oracle Text 11g offers state-of-the-art indexing capabilities and provides the underlying search capabilities for Oracle Secure Enterprise Search (Oracle SES). However, Oracle Text 11g has its own query syntax, which is intended more for use by applications or information professionals rather than casual end-users.

OracleTextSearch enables administrators to specify certain metadata fields to be optimized for the search index and to customize additional fields. This feature also enables a fast index rebuild and index optimization.

This section covers the following topics:

- "Considerations"

- "Configuring OracleTextSearch for Content Server"

- "Indexing and Query Speeds and Techniques"

- "Fast Rebuild"

- "Query Syntax"

- "Search Operators"

- "Case Sensitivity and Stemming Rules"

- "Search Results Data Clustering"

- "Snippets"

- "Additional Changes"

- "Determining Fields to Optimize"

- "Assigning/Editing Optimized Fields"

- "Performing a Fast Rebuild"

- "Modifying the Fields Displayed on Search Results"

- "Searching with OracleTextSearch"

- "Search Results with OracleTextSearch"

6.1.1 Considerations

The following items are important when considering use of OracleTextSearch:

- Oracle Universal Content Management (Oracle UCM) version 11g Release 1 (11.1.1) supports all languages supported by Oracle Text 11g.

- Oracle Text 11g runs on Oracle Database 11g. The Oracle UCM system database can be Oracle Database 11g, Microsoft SQL Server, or other databases as listed in the UCM 11g Release 1 (11.1.1) Certification Matrix. However, if the system database is not Oracle Database 11g, then an external provider for OracleTextSearch must be configured. See "Configuring OracleTextSearch for Content Server".

- When using OracleTextSearch, Oracle Database version 11.1.0.7.0 or higher is required, and any SDATA field is limited to a maximum of 249 characters. All Optimized Fields are SDATA fields, which by default include dDocName, dDocTitle, dDocType, and dSecurityGroup. The total number of sdata fields is limited to thirty-two (32) fields. Note that without Folders_g enabled, the dDocTitle field is limited to 80 characters by default.

- While Oracle UCM provides numerous search options using a variety of databases (Oracle, Microsoft SQL Server, IBM DB2), by default the database that serves as the search index is the same system database used by Oracle UCM to manage metadata and other configuration information (users, security groups, and so on.). The OracleTextSearch feature enables Oracle Text 11g as a separate search collection instance on Oracle Database 11g for Oracle UCM, which allows the search collection to reside on a separate computer and not compete with Oracle UCM for processors and memory. This can improve indexing and search response time.

- The OracleTextSearch collection instance can be installed on a different platform than the Oracle UCM installation.

- If OracleTextSearch is installed and running, and metadata fields are pushed into Content Server either by the administrator or by a component (requiring that Content Server be restarted), then the OracleTextSearch index must be rebuilt before content using the new metadata fields can be checked in to Content Server.

6.1.2 Configuring OracleTextSearch for Content Server

If the Oracle UCM system database used with OracleTextSearch is not Oracle Database 11g, then an external provider for OracleTextSearch must be configured.

1. Open the config.cfg file for the Content Server instance in a text editor.

2. Set the following property values:

SearchIndexerEngineName=OracleTextSearch

IndexerDatabaseProviderName=SystemDatabase

AdditionalEscapeChars=-:#

Note:
You can specify a separate Oracle Database as the value of IndexerDatabaseProviderName, instead of SystemDatabase. However, before OracleTextSearch can function properly with the separate Oracle Database, you need to manually copy the ojdbc14.jar file from the ECM_ORACLE_HOME/ucm/idc/shared/classes folder to the UCM_DOMAIN/config/lib folder.

3. Save the file.

4. Restart Content Server.

5. Rebuild the search index.
For more information on rebuilding the index, see "Working with the Search Index". For more information on configuring Content Server and OracleTextSearch during installation, see Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite.

6.1.3 Benefits and Features of Using Oracle Text 11g

This section covers the following topics:

- "Indexing and Query Speeds and Techniques"

- "Fast Rebuild"

- "Query Syntax"

- "Search Operators"

- "Case Sensitivity and Stemming Rules"

- "Search Results Data Clustering"

- "Snippets"

- "Additional Changes"

6.1.3.1 Indexing and Query Speeds and Techniques

Using Oracle Text 11g, Oracle UCM offers a significant increase in index speeds. Oracle Text indexing is transactional. Content Server sends a batch of document to Oracle Text, commits the batch, then starts the Oracle Text indexer. Content Server is notified of which documents failed to index and only those documents are resubmitted to be indexed. Content Server also supports the use of parallel indexing with the database, which can leverage multiple CPUs on the database server. This parallel indexing option can be enabled by the following Content Server configuration variable in the config.cfg file:

OracleTextIndexingParallelDegree=1

Search query response times are improved by increased indexing speeds and additional capabilities in Content Server to optimize the search collection. These capabilities include an automatic Fast Optimization for every 5,000 documents added to the Content Server instance, and a Full Optimization for every 50,000 documents or 20% growth of the repository.

Oracle UCM uses some of the newest Oracle Text 11g features. For example, Content Server automatically creates a new search index zone for each text information field in order to provide better search speed. Using information zones enables Content Server to query data as if it were full-text data. All text-based information fields (text, long text, and memo) are automatically added to as separate zones. In addition to the zones created for text information fields, Content Server provides an extra zone named IdcContent, which enables custom components, Inbound Refinery components, applications, or users to create XML content with tags that will be indexed as full-text metadata fields.

Oracle UCM uses the SDATA section feature in Oracle Text 11g to index important text, date, and integer fields and define them as Optimized Fields. The SDATA section is a separate XML structure managed by the Oracle Text engine that allows the engine to respond rapidly to requests involving data and integer ranges. Content Server can have up to 32 Optimized Fields, which includes data, integer, standard Content Server fields like dInDate, dOutDate, and fields selected to be optimized. All Optimized Fields are SDATA fields, which by default include dDocName, dDocTitle, dDocType, and dSecurityGroup.

Note:
If you want to change the set of Optimized Fields defined in Oracle Text 11g, the maximum allowed number of Optimized Fields is 32.

6.1.3.2 Fast Rebuild

OracleTextSearch provides a Indexer Rebuild Screen when you use the Collection Rebuild Cycle Screen on the Repository Manager: Indexer Tab. The Fast Rebuild feature allows the search engine to add new information to the search collection without requiring a full collection rebuild. A Fast Rebuild is required in the following cases:

- Adding or removing information fields

- Changing any Optimized Field

- Changing an information field to be an Optimized Field

A Fast Rebuild does not cause all the information (metadata and full-text) to be re-indexed. It adds the changes throughout the collection and updates it. Content Server search functionality is not affected during a Fast Rebuild cycle.

6.1.3.3 Query Syntax

Queries defined in Universal Query Syntax are supported and generally do not need any modification. This includes queries saved by users, queries defined in custom components, and queries defined in Site Studio pages.

6.1.3.4 Search Operators

Oracle Text supports the following defaults:

- CONTAINS

- MATCHES

- Has Word Prefix

- Range searches for dates and integers

The Oracle Text 11g engine supports additional search operators and functions which are not exposed in the user interface by default, but can be exposed through customization that adds to the operator definition HDA table. For details and examples of these operators see Oracle Text Reference.

6.1.3.4.1 Search Thesaurus

Certain queries, such as stem and Related Term, may be more effective if you use an Oracle Text thesaurus. Oracle Text enables you to create case-sensitive or case-insensitive thesauri which define synonym and hierarchical relationships between words and phrases. You can then search and retrieve documents that contains relevant text by expanding queries to include similar or related terms as defined in the thesaurus. For example, you can populate a thesaurus with specific product names, associated models, associated features, and so forth.

- Default thesaurus: If you do not specify a thesaurus by name in a query, by default, the thesaurus operators use a thesaurus named DEFAULT. However, Oracle Text does not provide a DEFAULT thesaurus.
As a result, if you want to use a default thesaurus for the thesaurus operators, you must create a thesaurus named DEFAULT. You can create the thesaurus through any of the thesaurus creation methods supported by Oracle Text:

- CTX_THES.CREATE_THESAURUS (PL/SQL)

- ctxload utility

- Supplied thesaurus: Oracle Text does not provide a default thesaurus, but Oracle Text does supply a thesaurus, in the form of a file that you load with ctxload, that can be used to create a general-purpose, English-language thesaurus.
The thesaurus load file can be used to create a default thesaurus for Oracle Text, or it can be used as the basis for creating thesauri tailored to a specific subject or range of subjects.

Note:
See the Oracle Text Reference to learn more about using ctxload and the CTX_THES package, and see the chapter, "Working With a Thesaurus in Oracle Text," in the Oracle Text Application Developer's Guide.

6.1.3.5 Case Sensitivity and Stemming Rules

Content Server automatically ensures that queries are executed as case-insensitive. By default, all full-text and text field search queries are case-insensitive. Content Server also handles case-insensitive search queries for information stored as Optimized Fields.

Content Server does not apply any stemming rules by default for Oracle Text 11g, but stemming rules can be applied by using the stem() function. Stemming rules may be used to have searches account for plurals, verbs, and so forth. Other methods for implementing stemming rules include modifying the standard query definition in the searchindexerrules configuration file, and by making configuration changes in the Oracle Text engine (Oracle Database).

Content Server handles content in non-English languages by using the WORLD_LEXER feature in the Oracle Text engine. This enables Oracle Text to automatically identify the language and apply the proper tokenization rules.

6.1.3.6 Search Results Data Clustering

With OracleTextSearch, Content Server retrieves additional information about a search result list and displays it in a new menu bar on the Search Results page. This information summarizes how many documents are attached to specific values in specific information fields. Content Server supports data clustering for up to four information fields (the default fields are Security Group and Document Type).

This can be useful if you have a query that returns many items. For example, a result set could include 200 content items, including 100 documents that belong to the Public security group, 75 that belong to the Sales group, and 25 that belong to the Marketing group. The menu option for Security Group will show you the list of values and how many documents belong to each value. You can select one of the values (Public, Sales, Marketing) from the menu and it will list only those documents in the result set that belong to that value.

6.1.3.7 Snippets

Content Server can retrieve document snippets as part of search results to show the occurrence of search terms in context of their usage. This feature is disabled by default. To enable this feature, although it can affect search query performance, set the following configuration entry in the config.cfg file:

OracleTextDisableSearchSnippit=false

6.1.3.8 Additional Changes

Additional changes because of the use of Oracle Text 11g include:

- XML content is automatically indexed.

- There are no visible changes in the Search user interface other than removal of Substring as a search operator option. The default search operators are CONTAINS, MATCHES, and HAS WORD PREFIX. Substring-based queries will still work.

- Queries using the MATCHES operator on a non-optimized field will behave like a CONTAINS query. For example, if xDepartment is not optimized, then the query xDepartment MATCHES 'Marketing' will behave like xDepartment CONTAINS 'Marketing' and return hits on documents that have an xDepartment value of 'Marketing Services'' or 'Product Marketing'.

- Relevancy ranking can be changed in Oracle Text 11g through use of an operator called DEFINESCORE. This operator can be added through a component to the WhereClause value of OracleTextSearch in the SearchQueryDefinition table (in the searchindexerrules configuration file). More information about this operator is available in the Oracle Text Reference document.

- Complicated queries that previously could be placed into the full-text search box should now be placed in the advanced options on the Query Builder Form. The Query Builder Form is documented in the Oracle Fusion Middleware User's Guide for Content Server.

- If you need to specify an escape character, use the configuration variable AdditionalEscapeChars=. The default setting is:

AdditionalEscapeChars=_:#,-:#

The default sets an underscore (_) and a hyphen (-) as escape characters.

- The PDF Highlighting feature has been disabled.

- The Spell Checking feature can be enabled, but it requires a custom component just as it did with Autonomy VDK.

6.1.4 Managing OracleTextSearch

This section covers the following topics:

- "Determining Fields to Optimize"

- "Assigning/Editing Optimized Fields"

- "Performing a Fast Rebuild"

- "Modifying the Fields Displayed on Search Results"

6.1.4.1 Determining Fields to Optimize

Consider the following when determining the fields to optimize:

- Do you want an exact match in a query?

- Do you want that match to work faster in a search?

- Do you want to sort search results by field?

By default the OracleTextSearch feature optimizes the Content ID and Document Title metadata fields.

A maximum number of 32 fields can be defined as Optimized Fields with the OracleTextSearch feature. Content Server can have up to 32 Optimized Fields, which includes data, integer, standard Content Server fields like dInDate, dOutDate, and fields selected to be optimized. All Optimized Fields are SDATA fields, which by default include dDocName, dDocTitle, dDocType, and dSecurityGroup.

The display of integer fields is dynamic and depends on the Content Server system configuration.

6.1.4.2 Assigning/Editing Optimized Fields

To select metadata Non-Optimized Fields and assign them to be Optimized Fields for search purposes, or to edit Optimized Fields and make them Non-Optimized, complete these steps:

1. Log on to Content Server as system administrator.

2. Click Administration in the navigation bar.

3. Click Admin Applets.

4. Click Configuration Manager, then the Information Fields tab, then Advanced Search Design.
For more information on the Configuration Manager applet, see Oracle Fusion Middleware Application Administrator's Guide for Content Server.

5. To make a metadata field Optimized, click Edit Fields. In the Advanced Options for "metadata_field" screen, select the Is Optimized check box.

6. To edit an Optimized Field and make it Non-Optimized, click Edit Fields. In the Advanced Options for "metadata_field" screen, deselect the Is Optimized check box.

7. When you have completed moving fields, use Index Fast Rebuild in Repository Manager to update the search collection to use the new and modified fields.

Note:
The Fast Rebuild does not function if a search collection rebuild is in progress.

6.1.4.3 Performing a Fast Rebuild

The Fast Rebuild feature allows the search engine to add new information to the search collection without requiring a full collection rebuild. A Fast Rebuild is required in the following cases:

- Adding or removing information fields

- Changing any Optimized Field

- Changing an information field to be an Optimized Field

To perform a Fast Rebuild, complete these steps:

1. Log on to Content Server as system administrator.

2. Click Administration in the navigation bar.

3. Click Admin Applets, then Repository Manager, then the Indexer tab.
The Repository Manager: Indexer Tab is displayed.

4. On the Collection Rebuild Cycle Screen, click Start.
The Indexer Rebuild Screen is displayed with a warning that rebuilding the search index is a time-consuming process. If you do not want to start a rebuild now, click Cancel; otherwise, continue with this procedure.

5. On the Indexer Rebuild Screen, click OK.
A Fast Rebuild of the search collection is performed.

Note:
A Fast Rebuild does not be performed if a rebuild of the search collection is in progress.

6.1.4.4 Modifying the Fields Displayed on Search Results

The OracleTextSearch feature provides default menu options on the Search Results page (set by the Oracle Database configuration script):

DrillDownFields=dDocType, dSecurityGroup

Administrators can add one more option from the list of Optimized Fields to further customize the search results. Edit the configuration to add the option to the list of DrillDownFields.

Note:
A Fast Rebuild must be performed after making any change in the DrillDownfields setting.

6.1.5 Searching with OracleTextSearch

Performing a search is generally the same except for the following:

- There are no visible changes in the Search:Expanded Form page other than removal of Substring as a search operator option. The default search operator is CONTAINS. Substring-based queries still work.

- Queries using the MATCHES operator on a non-optimized field behave like a CONTAINS query. For example, if xDepartment is not optimized, then the query xDepartment MATCHES 'Marketing' behaves like xDepartment CONTAINS 'Marketing' and returns hits on documents that have an xDepartment value of 'Marketing Services' or 'Product Marketing'.

6.1.6 Search Results with OracleTextSearch

When users run a search using the Search:Expanded Form, the Search Results page displays an additional menu bar with options that enable users to selectively view search results. The options represent categories used to filter the search results. The options can be context-sensitive, so if only one content item is returned for an option, then it shows only the one result in the menu itself, as shown in Figure 6-1. The default set of options include content type, security group, and account.

Note:
Two default menu options on the OracleTextSearch menu bar can be replaced by customized menu options: Security Group and Document Type.

If more than one content item is found for an option, an arrow is displayed next to the option name. When you move your cursor over the option name, a popup will display the list of the categories found in the search results for that option and the number of content items for each of the categories. You can click any category name in the popup to change the search results page to list only those items that match the category, as shown in Figure 6-2 where the Security Group lists the following categories and number of items found: Administration- (3), Marketing- (1), Public- (14), Secure- (5), Production- (1).

Figure 6-1 Search results with OracleTextSearch default menu

Figure 6-2 Search results with snippets display and expanded OracleTextSearch menu

Element

Description

Filter by Category

Displays the categories used to filter the search results; for example, Content Type, Security Group, Account.

Content Type

(Default) Lists the types and the number of each type of content items in the search results.
Clicking one of the content type names will change the search results list to show only those items that match the content type.

Security Group

(Default) Lists the security groups and number of content items assigned to each group in the search results. Security groups include Administration, Public, and Secure.
Clicking one of the security group names will change the search results list to show only those items that match the security group.

Account

(Default) Lists the account types and number of items assigned to each account in the search results.
Clicking one of the account types will change the search results list to show only those content items that match the account.

6.2 Oracle Secure Enterprise Search

Oracle Secure Enterprise Search (SES) 11g enables a secure, high quality, easy-to-use search across all enterprise information assets. If you have a license to use Oracle Secure Enterprise Search 11g, the OracleTextSearch component enables the use of this technology as the primary full-text search engine for Oracle Universal Content Management (Oracle UCM).

For details, see Oracle Secure Enterprise Search Administrator's Guide.

Note:
Documents using Need To Know component security can not be configured for use with Oracle Secure Enterprise Search.

6.2.1 Configuring Oracle SES and Oracle UCM

To configure Oracle SES 11g as an external search engine for Oracle UCM 11g, follow these steps:

Note:
If you are already using a search engine other than Oracle SES with Oracle UCM, such as that set up on the Oracle UCM Post Configuration page, and you want to change the search engine to Oracle SES, then you must create a new database provider and configure Oracle SES for Oracle UCM using that provider.

1. After installing Oracle SES, edit the file $ORACLE_HOME/network/admin/sqlnet.ora to comment out the following two lines:

tcp.invited_nodes
tcp.validate_checking

2. If Oracle SES is running, shut it down (mid-tier and database):

$ORACLE_HOME/bin/searchctl stopall

3. Start the database:

$ORACLE_HOME/bin/searchctl start_backend

4. Find database connection information for later use in the following file:

$ORACLE_HOME/search/webapp/config/search.properties

5. Run the Oracle Fusion Middleware Repository Creation Utility (RCU) against Oracle SES and create the OCSEARCH schema.
OCSEARCH sets only the search portion of a database already set up by RCU with Oracle SES.

6. Perform a standard Oracle Enterprise Content Management Suite installation and Oracle UCM installation.

Note:
Do not complete the postconfiguration steps on the Oracle UCM Post Configuration page, because the page sets up a regular database configuration. For instructions on performing the Oracle Enterprise Content Management Suite installation and Oracle UCM configuration, see Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite.

7. Create a new DataSource (WLS_Data_Source) in Oracle WebLogic Server to connect to Oracle SES.

8. On the Oracle UCM Post Configuration page, click Select External in Full Text Search options, then enter the DataSource name.

9. Restart Oracle UCM.

7 Managing System Migration and Archiving

This chapter provides information about the following topics:

- "Introduction to Migration Tools and Components"

- "Archiving Overview"

- "Migrating System Configurations"

- "Archives, Collections and Batch Files"

- "Exporting Data in Archives"

- "Importing Data"

- "Transferring Files"

- "Replicating Files"

- "Archive and Migration Strategies"

- "Folder Archiving"

- "Folder Structure Archiving"

- "Archiver Replication Exceptions"

- "Troubleshooting Archiving Issues"

7.1 Introduction to Migration Tools and Components

This section provides conceptual, reference, and step-by-step information for the tasks needed to migrate both the content and structure of one Content Server to another. It provides information about the following migration tools:

- The Configuration Migration Utility component: Used to select elements of your Content Server instance to migrate to another instance.

- Archiver: A Java applet used to transfer and reorganize content server files and information. The archiver can be used with the migration utility to migrate a complete content server, including content, from one system to another.

- Folder Archiving: Used to migrate the folder structure of your Content Server from one location to another.

- The FolderStructureArchive component: Used to copy the folder structure (and its content) and create an exact copy on another computer. It ensures that the folder copies and respective contents remain synchronized across different systems.

- The ArchiverReplicationExceptions component: A Content Server component that is used to prevent failed imports from stopping replication.

7.2 Archiving Overview

Several different tools are available to archive Content Server structure, content and folders. Each tool serves a different purpose and they can all be used together. This section provides an overview of these tools and their uses. The remainder of this document provides a detailed discussion about using the Configuration Migration Utility and the Archiver.

- "Configuration Migration"

- "Archiver"

- "Folder Archiving"

- "FolderStructureArchive Component"

- "ArchiveReplicationExceptions"

- "Archive Tool Summary and Comparison"

- "Running the Archiver as a Standalone Application"

7.2.1 Configuration Migration

The Configuration Migration Utility component is used to select elements of your Content Server instance to migrate to another instance. This component is installed and enabled by default with Content Server.

Overview

You can select individual elements (such as workflow tokens or content types) or entire sections (such as all user-related metadata or all metadata related to workflows). In addition, you can export and import an entire content server to create a snapshot of the content server at a certain point in time. It can be used to migrate a system from testing to production, or to provide an upgrade path from versions of the content server. By using the migration tool, you can keep an older version of the Content Server in production while testing new functionality on a newer version.

Each export configuration is packaged as a bundle which contains the information needed to re-create the configuration on another system. A bundle is a zip file that can be easily shared with other systems.

Functions

The Configuration Migration Utility is used to configure migration bundles for exporting to other systems. It is also used to upload and import bundles on an importing system. There are four main functions:

- Upload Bundle: used to find a copy of an exported bundle and make it available for use on a receiving system.

- Configuration Bundles: used to import the configuration from the uploaded bundle. This function creates new metadata fields or overwrites current fields, depending on options chosen during import.

- Configuration Templates: used to create export bundles, which can later be uploaded and imported to another content server.

- Recent Actions: used to view recent activity such as imports and exports and to view a log of those activities.

By using the Configuration Migration Utility with the Archiver, you can create a snapshot in time of your existing content server or you can use it to keep track of incremental updates to an existing system. The Configuration Migration Utility captures configuration information while the Archiver captures content.

See "Migrating System Configurations" for details about using the Configuration Migration Utility.

7.2.2 Archiver

Archiver can be used with the Migration utility to migrate a complete Content Server instance, including content, from one system to another.

Note:
Archiver does not include Digital Asset Management (DAM) video and audio renditions in the archives it creates. The archives do include the native file, thumbnail, the zip rendition that contains storyboard thumbnails, and the web-viewable .hcsp file, but do not include any additional video and audio renditions created by Inbound Refinery.
This limitation is by design. Many video files would make the archive too large, surpassing the 2GB limit on zip files. Also, in man production instances the video renditions are likely to be stored on a separate filesystem.

Overview

Archiver can be run as an Admin Applet, accessed from the Admin menu, or as a standalone version. The standalone version is required to:

- Create collections.

- Create a new archive by copying from an existing archive.

- Browse the local file system to connect to new collections.

See "Running the Archiver as a Standalone Application" for details about using Archiver in standalone mode.

Functions

Archiver is a Java applet that is used to transfer and reorganize content server files and information. Archiver has four main functions:

- Export: Used to copy native and web-viewable files out of the content server instance for backup, storage, or import to another content server instance. You can also export content types and user attributes. You export to an archive, which contains the exported files and their metadata in the form of batch files.

- Import: Used to retrieve files and content server information from an exported archive. Importing is typically used to get a copy of content from another content server or to restore data that has been in storage. You can also change metadata values during an import.

- Transfer: Used to transfer content from one content server instance to another over sockets. This is typically used to move or copy content across a firewall or between two content servers that do not have access to the same file system. You can also use the Transfer function to transfer archive files between content server systems that have access to the same file system.

- Replicate: Used to automate the export, import, and transfer functions. For example, you can use replication to automatically export from one content server instance, transfer the archive to another computer, and import to another content server instance.

The following illustration demonstrates these basic functions.

Figure 7-1 Archiver Functions

Caution:
Do not use Archiver as your primary method of disaster recovery; use standard backup systems for the database and file system.

7.2.3 Folder Archiving

You cannot use the Archiver to move folder structure and content, but you can use Folder Archiving to migrate the total folder structure of your Content Server from one location to another. This does not archive the folder content, just the folder structure.

Using Folder Archiving you can export and import the folder hierarchical structure directly from the Folders administration interface. The entire folder hierarchy is exported to a text file in HDA format, which can then be read by the Content Server when it is imported.

7.2.4 FolderStructureArchive Component

The FolderStructureArchive component is a separate product from the Folders component and must be installed separately.

Overview

The FolderStructureArchive component can be used with the archiving aspect of the Folders component but its functionality differs in several ways:

- It can export selected portions of the folder structure. The Folders Archive function can only export the entire folder structure.

- It can create incremental archives. These are archives that contain only changed folders. The built-in Folder Archive function creates archives that contain all items.

- It can include both the folder structure and folder content in the archives. The Folder Archive function can only export the folder structure and none of the content.

Functions

This component can be used for three major purposes:

- As a backup tool. With this component you can copy the folder structure, including its content.

- As a duplication tool. This component can be used to copy the folder structure and content and create an exact copy on another computer, helping to simplify multiserver setups.

- As a synchronization tool. With this component you can ensure that copies of your folders and their contents are kept synchronized across different systems.

7.2.5 ArchiveReplicationExceptions

The ArchiverReplicationExceptions component is installed (enabled) by default with Content Server. It enables administrators to prevent failed imports from stopping replication. It does this by capturing such failed imports and putting them into an exceptions archive and sending out email to the administrator that such a failed import has occurred.

For content items to be processed by ArchiverReplicationExceptions, the administrator must manually set configuration entries in the IntradocDir/config/config.cfg file. The configuration variables customize the behavior of the importing content server to allow for certain situations and to distribute the error reporting based on the configured criteria.

7.2.6 Archive Tool Summary and Comparison

The tools that can be used to archive structure, content, and folders all serve different purposes. All of the tools can be used together, but sometimes one might be preferred over the other. The following table summarizes each tool and its strengths and limitations.

Feature

Configuration Migration Utility (CMU)

Archiver

Folder Archiving

Folder Structure Archive Component

Primary purpose

A 'snapshot' tool, used to migrate one Content Server to another or to migrate to an upgraded instance

Primarily used for backup, storage, and transfer of data over sockets

Used to export and import a complete folder structure or hierarchy

Used to backup and duplicate a folder structure to synchronize the contents with another Content Server

Strengths

Enables you to choose specific parts of the Content Server to migrate
Provides logging and trace files

Works with older content
Provides logging and trace files

Ensures that the collection IDs on the target match those on the source

Can export selected portions of the folder structure.

Limitations

Cannot be used on pre-6.2 versions of Content Server.
Migration of components can be difficult.

The standalone version is needed to create collections.
Imported revisions do not automatically enter a workflow.

All current folders and content items in the folders are removed from the Content Server and replaced by the imported folder hierarchy.

Does not ensure that the collection ID of folders on the target match those on the source content.

What it archives

- Metadata

- Security (roles and accounts)

- Profiles

- Schema

- Workflow

- Personalization

- Add-on components

- Content

- Content types

- User attributes

- Subscriptions

- Security groups

- File Formats

- Complete folder hierarchy (no content)

- Complete or partial folder hierarchy and content

- Only changed content (if desired)

What it does not archive

- Content

- Publisher projects

- Workflow state

- Does not synchronize: this is an additive archive

- Folder structure

- Metadata, security and other features which are archived by CMU

- Weblayout structure

- Partial or selected folder hierarchy

- Collaboration folders

- Content

- Metadata, security (other features which are archived by CMU)

Collaboration folders

7.2.7 Running the Archiver as a Standalone Application

The following information details how to run the Archiver as a standalone application, which is required to create collections.

To run Archiver in Windows:

To run Archiver on a Windows operating system:

1. Select the application from the Windows Start menu:
Click Start, select Programs, Content Server, instance_name, and then click Analzyer.

A login screen or application screen is displayed.

Tip:
It may take several seconds for the login screen or the application screen to appear, and the screen may be hidden by other windows.

2. If required, enter the administrator login name and password, then click OK.
The Main Archiver Screen is displayed.

To run Archiver in UNIX:

To run Archiver on a UNIX operating system:

1. Navigate to the DomainHome/ucm/cs/bin/ directory.

2. Enter ./archive

3. If required, enter the administrator login name and password.
The Main Archiver Screen of the application is displayed.

7.3 Migrating System Configurations

Configuration migration is used with the Archiver to export one content server configuration to another content server. Archiver is used to migrate content and the Configuration Migration Utility component exports the configuration and customization of the content server.

- "Configuration Migration Utility Details"

- "Migration Tips"

- "Managing Configuration Migration"

7.3.1 Configuration Migration Utility Details

This section describes the structure of the Configuration Migration Utility and how it uses templates and bundles. For an overview of this utility and how it compares to other archiving tools, see "Archiving Overview".

7.3.1.1 Migration Structure

A bundle is a set of configuration information that is packaged into a single zipped file and made ready for exporting to another content server.

Information is stored in the DomainHome/ucm/cs/cmu/instance/ directory.

Figure 7-2 Migration Directory Structure

The bundles subdirectory contains specific bundles and associated information. The templates subdirectory contains configuration templates which can be used for new export files.

Figure 7-3 The Bundles Subdirectory

Each configuration bundle is in a separate subdirectory and contains all the relevant files needed to export that bundle.

Figure 7-4 Files in Configuration Bundle

Within the specific directories, any customization that is unique to the instance in that export (such as customized metadata fields, schemas, and so on) are included in a separate subdirectory.

Figure 7-5 Customization Stored in Directory

The following files are included in these different subdirectories:

File or Directory

Description

bundle directory

Each bundle has a subdirectory in the /bundles directory. The subdirectory is given the name assigned to the bundle when the configuration export was created.

templates directory

Contains export rules created from bundles. When a configuration export is created and saved, a name is given to that export and the configuration is stored as a template in the templates directory

hda files

Contains definitions and details of customization and other elements of the exported instance. Depending on how the export was defined, information can be bundled into one .hda file or into several.

7.3.1.2 About Migration Templates and Bundles

A migration template is a set of configuration options which specify what content server items will be exported. For example, a template named FullCSExport may contain all content server items (schema, custom metadata, workflows, and so on). Another template named UserCSExport may only contain options that pertain directly to users (security groups, roles, and so on).

These templates are used to create configuration bundles. A bundle uses the template to determine what to export and to create the necessary definition files which will be exported with the content server items. The bundle name is used to identify the finished result of an import or an export. The bundled information is put into a zipped file, containing all the necessary definition files.

7.3.2 Migration Tips

It is important to remember that migration entails the bundling and copying of information about the content server instance. It does not include any of the actual content that is in the content server. Archiver is used to export content. You should take care that if you archive specific content and plan to export it to another system, the metadata information for that content is also migrated using the Configuration Migration Utility.

When migrating information from one content server to another, there is not a merging of information. Migration is an additive process. The exporting configuration bundle of metadata information is added to the metadata that currently exists in the importing content server. If metadata information currently exists that matches the metadata being imported, and if the Force Overwrite rule has been selected during import, then duplicate bundles are replaced. See "Uploading a Bundle" for information about the Force Overwrite option.

Configuration Migration Utility administration tasks must be performed using a specific node of a cluster. If you do not use a specific node, then an error might occur because the job number assigned to an action is known only to the node that started the action.

You cannot import a configuration on a 6.2 version of the Content Server. The Edit, Preview, and History options will not appear on the bundle's options on the Configuration Bundles page on a 6.2 Content Server.

If you import a template to use on another content server and if the importing system does not have the same metadata fields, you will not be able to use that template for export later. You must upload the template, import the configuration, and then use it for exporting. See "Importing a Template" for details about the import process.

7.3.2.1 Limitations

Keep the following limitations in mind when using the Configuration Migration Utility:

- When exporting workflow configuration information, only the workflow definition is exported. The state of the workflow is not exported.

- If importing and overwriting existing workflows, ensure that you have the same step names for each workflow.

- If you import a workflow to a new content server, the workflow will not retain the same state information as that of the exporting content server. For this reason, you should not plan to export active workflows.

- This utility is not a cloner. It does not synchronize information with another system, it only copies and moves information.

- This utility cannot be set up to migrate automatically.

- Errors may arise when migrating docmeta information from earlier versions of the content server due to the use of schemas in later versions of the content server.

- You cannot import users from a 6.2 or 7.0 version of the system to a later version due to Archiver limitations.

- Migrating the config.cfg file may have errors because some values are not migrated for safety reasons (for example, IDC_Name). Others values, such as that for AutoNumberPrefix, are migrated.

- Migrating components can be difficult because no preference prompts (for example, in Folders or RMA) and no database tables can be migrated.

- No support is provided for Publisher projects or for bundles in components.

7.3.2.2 Migration Logs

You can enable migration trace logs to track activity during migration events. The logs are enabled by clicking System Audit Information on the Admin Applets screen or under the Administration tray. In the Tracing Section Information portion of the page, select cmu from the Active Sections menu. Configuration Migration Utility logs will be included in the trace files that are run.

To access the logs, click View Server Output from the Actions menu on the page. The Configuration Migration Utility log information is included with other tracing logs that are generated.

7.3.3 Managing Configuration Migration

Migration consists of several tasks such as creating migration templates, creating migration bundles, and exporting or importing the configuration.

- "Creating a Configuration Migration Template"

- "Editing a Configuration Template"

- "Importing a Template"

- "Creating a One-Time Export"

- "Exporting a Configuration"

- "Uploading a Bundle"

- "Importing a Bundle"

- "Downloading a Bundle"

- "Viewing Status Information"

7.3.3.1 Creating a Configuration Migration Template

1. Select the Configuration Templates option from the Migration Options or from the top menu on any Migration screen.

2. Select Create New Template from the page Actions menu on the Configuration Templates Page.
The Config Migration Admin Screen is displayed.

3. Choose the Action Options for the export.

- To create an export template that will continue the export process even if an error is encountered, select Continue on Error. The export will proceed but errors will be reported on the Action History Page.

- To have email sent to the person initiating the export, select Email Results. Email will be sent to the person who performs the export, not the person who created the export template.

- To have known dependencies added to the export or import bundle, leave the Add Dependencies option selected. If this is unselected, dependencies are checked and noted with an error flag in the log file but the bundle action continues.

- To ignore all dependencies during export or import, select Ignore Dependencies. Ignoring dependencies may avoid errors during the export process, but may cause errors when an import is done. If you are certain that all the necessary fields are present in the content server, you can uncheck Add Dependencies and check Ignore Dependencies to import a field without dependencies being added.

4. You can create a custom name for this bundle. Custom names should be used sparingly to avoid possible name collisions. If a custom name is not selected, the system creates a name based on the bundle name given when you save the template. Custom names cannot contain spaces or special characters (#, $, % and so on).

5. Choose the Content Server Sections to be included from the Content Server Sections portion of the screen.

- To use all sections, click Select All on the page Action menu.

Note:
Some Content Server sections are not displayed; not all are supported on all versions of the Content Server and some cannot be safely migrated.

- To use only specific content server items, click Content Server Sections then click the individual section name to include. To include all items in that section, click Select All from the page Action menu. To use only a subset, select the individual items by putting a check in the selection box on the item's row. Some sections may have action options that are specific to that section. Select the option for the section by checking the selection box.

Tip:
If you want to use the majority of the metadata, use the Select All menu option. Then click the individual sections that you do not want to use.

6. Preview the selections you made by clicking Preview from the page Actions menu. The Preview Screen is displayed.

7. Continue editing and adding selections by clicking Edit from the page Actions menu. Click Preview to view your changes.

8. When the template is complete, click Save from the page Actions menu. If you do not elect to save the template, your configuration changes will be lost.
The Edit Export Rule Screen is displayed.

9. Enter a name for the template. Names cannot contain spaces or special characters (#, $, %, and so on). A name can include details of the date of the export (for example, Nov10FullExport) or describe the contents (FullExportNoDependencies) or can be meaningful in any way that is appropriate for your use. Click Save when finished entering the name.

10. The Config Migration Admin Screen is re-displayed.

- To create another template using the current template, select Save As from the page Actions menu. The Edit Export Rule Screen is displayed again where you can create a new name.

- To alter the selections for exporting, make any changes then select Save from the page Actions menu to change the selections and retain the name entered in step 9 or Save As from the page Actions menu to give it a new name on the Edit Export Rule Screen.

- To export the configuration, select Export from the page Actions menu. See "Exporting a Configuration" for details.

After creating the configuration, you can export it and create a bundle for use on another system. See "Exporting a Configuration" for details.

7.3.3.2 Editing a Configuration Template

1. First choose a template to be edited. Use one of the following methods to choose a template from the Configuration Templates Page:

- Click the template name.

- Select Edit from the individual template Actions menu.

The Config Migration Admin Screen is displayed.

2. Follow the steps detailed in "Creating a Configuration Migration Template" to select the items you want in the revised template:

- Choose the Action Options for the template.

- Choose the Content Server Sections to be included from the Content Server Sections portion of the screen.

3. Preview the selections you made by clicking Preview from the page Actions menu. The Preview Screen is displayed.

4. Continue editing and adding selections by clicking Edit from the page Actions menu. Click Preview to view your selections.

5. When the template is complete, click Save from the page Actions menu to save the template under its current name or Save As to give it a new name. If you do not elect to save the template, your configuration changes will be lost.
The Edit Export Rule Screen is displayed where you can enter a new template name.

7.3.3.3 Importing a Template

Follow these steps to import a template from another system for use on the current instance.

1. Select Upload Bundle from the Migration Options or from the top menu of any Migration screen.
The Upload Configuration Bundle Screen is displayed.

2. Use the Browse button to find the bundle that contains the template you want to use.

3. Select Create Export Template.

4. Click Upload.
The bundle appears on the Configuration Bundles Page. To use the template associated with that bundle, see "Editing a Configuration Template".

If you import a template to use for exporting and if the importing system does not have the same metadata fields, you must upload the template, import the configuration then use it for exporting. You cannot use the template for exporting unless the metadata fields are in place on the system that imported the template.

7.3.3.4 Creating a One-Time Export

Follow these steps to create an export template and immediately export the content server configuration.

1. Select the Configuration Templates option from the Migration Options or from the menus at the top of any Migration screen.

2. Select Create New Template from the page Actions menu on the Configuration Templates Page.
The Config Migration Admin Screen is displayed.

- Follow the steps detailed in "Creating a Configuration Migration Template" to select the items you want in the configuration:

- Choose the Action Options.

- Choose the Content Server Sections to be included from the Content Server Sections portion of the screen.

3. Preview the selections you made by clicking Preview from the page Actions menu. The Preview Screen is displayed.

4. Continue editing and adding selections by clicking Edit from the page Actions menu. Click Preview to view your changes.

5. When the template is complete, click Export from the page Actions menu. The configuration is immediately exported and the name of the exported bundle appears in the Latest Action Screen with a unique identifier similar to the following:

bundle-idcm1-25-20041110T135912

The initial portion of the name (bundle-idcm1) indicates the default bundle name (bundle) and the instance name (idcm). The next portion indicates the sequence number (25). The date follows (20041110 for November 11, 2004). Finally a unique control number is used to identify the exported bundle.

7.3.3.5 Exporting a Configuration

1. Use one of the following methods to choose an export configuration template from the Configuration Templates Page.

- Click the configuration name.

- Select Preview from the individual Actions menu if you want to view the items that will be exported.

The Preview Screen is displayed.

2. Select Export from the page Actions menu. If you select Export without previewing the bundle first, you are prompted to confirm that you want to perform the export.
The Latest Action Screen is displayed.

3. This screen refreshes automatically to show the most recent activities and their status.

To view details of the migration action, click the message in the Status column. See "Viewing Status Information" for more details.

After exporting, the bundle name appears on the Configuration Bundles page, indicating that it has been bundled. A date and time indicator is appended to the configuration name, as in the following example:

Nov23Bundle-idcm-1-20041123T122436

The initial portion of the name is the original bundle name. The instance name follows (idcm), followed by the date (20041123 for November 23, 2004) and the time (122436 to indicate 12:24:36). From this Import page, you can download the bundle to a new location so it can be uploaded onto another system.

The original template name (Nov23Bundle) continues to appear on the Configuration Templates page, where it can be re-exported at another time.

7.3.3.6 Uploading a Bundle

Before a configuration can be imported it must be first uploaded. Follow these steps to upload a bundle from another content server:

1. Select Upload Bundle from the Migration Options or from the top menu of any Migration screen.
The Upload Configuration Bundle Screen is displayed.

2. Use the Browse button to find and select the zipped bundle file you want to use.

3. If you want to use the template included with the bundle, select the Create Export Template check box.

4. If you want the new bundle information to overwrite existing content server configuration information, select the Force Overwrite check box.

5. Click Upload to load the bundle.

Tip:
If you are uncertain about the contents of a bundle, it is always safe to upload the bundle and preview the configuration contents. The bundle configuration is not applied to the importing system until you choose to import it.

7.3.3.7 Importing a Bundle

After a bundle is uploaded and resides on the importing system, it can be imported for use. Follow these steps to import the bundle:

1. Select Configuration Bundles from the Migration Options or from the top menu of any Migration screen.
The Configuration Bundles Page is displayed.

2. Click the name of the bundle you want to import.
The Config Migration Admin Screen is displayed with Overwrite Duplicates in place of the Custom Name field. Selecting this field will permit the importing bundle to overwrite any duplicate fields. If not selected, the import will error on duplicates and stop. It will continue if Continue on Error was checked but a status of fail appears on the Latest Action Screen.

3. Select an action from the page Actions menu:

- To preview the import configuration, click Preview. The Preview Screen is displayed where you can either select Edit from the page Actions menu to edit the configuration options or you can select Import to import the selections as is.

- To import the configuration without previewing, select Import from the Configuration Bundles page Actions menu. You are prompted to confirm that you want to import the configuration without previewing it first.

Important:
You should verify that you want to import the settings in the Server Config portion of the Content Server sections. These settings determine configurations such as the type of web server used, the mail server, and other system-specific items. You may not want to import those configuration settings on a new content server.

4. After selecting Import from either the Preview Screen or the Configuration Bundles Screen, the Latest Action Screen is displayed showing the status of the import.

5. This screen refreshes automatically to show the most recent history and status.
To view details of the action, click the message in the Status column. See "Viewing Status Information" for more details.

7.3.3.8 Downloading a Bundle

A bundle can be downloaded and stored in an easily accessible location for other instances of the content server to use.

Follow these steps to download a bundle:

1. Select Configuration Bundles from the Migration Options or from the top menu of any Migration screen.
The Configuration Bundles Page is displayed.

2. Select Download from the bundle Actions menu of the bundle to be downloaded. A prompt appears where you can enter the bundle location.

3. Enter the appropriate location and click Save.

7.3.3.9 Viewing Status Information

Follow these steps to view status information for any import or export actions:

1. Select Recent Actions from Migration Options or from the top menu of any Migration screen.
The Latest Action Screen is displayed.

2. To view details of the events, click a status in the message in the Status column.
The Action History Page is displayed.

Note:
The Recent History screen automatically appears after an export or an import.

7.4 Archives, Collections and Batch Files

Archiving your content consists of three elements: the archive itself, a collection, and a batch file.

- "Archive Details"

- "Managing Archives"

- "Managing Collections"

- "Managing Batch Files"

7.4.1 Archive Details

This section describes the structure of the archiver and how it uses collections and targets. For an overview of the archiver and how it compares to other archiving tools, see "Archiving Overview".

- "Archive Structure"

- "Collections"

- "Batch Files"

- "Archive Targets"

- "Using Archive Logs"

7.4.1.1 Archive Structure

An archive is a set of exported content files and their associated batch files. Each archive has its own subdirectory in the collection it belongs to.

Caution:
Do not edit any of the files created by Archiver.

Figure 7-6 Archive Directory Structure

An archive subdirectory includes the following:

File or Directory

Description

Batch file directories

Each batch file has a subdirectory in the archive. The subdirectory name reflects the date and time of the export, with a default format of yy-MMM-dd_HH.mm.ss_SSS. For example, 03-feb-04_15.04.14_174.

temp directory

Contains transferred Zip files.

archive.hda file

Specifies information about the archive, such as export and import settings, the export query, field and value import maps, archiving history, and so forth.

doctypes.hda file

Lists the content types (DocTypes database table) in the source content server. This file is present only if content types were exported.

exports.hda file

Specifies the batch files that are included in the archive.

users.hda file

Lists the user attributes (Users database table) in the source content server. This file is present only if user attributes were exported.

Figure 7-7 Archive Subdirectory Structure

7.4.1.2 Collections

This section provides information about collections.

Summary

A collection is a set of archives on a particular content server instance.

- Each instance has a default collection, which is located in the IntradocDir/archives/ directory. Additional collections can be created, but are necessary only in rare situations. For example, you could create a new collection if you want to save disk space by archiving to another system that does not have Content Server on it.

- Collections can be created only through the standalone Archiver. See "Running the Archiver as a Standalone Application" for details about using the standalone Archiver.

- A collection can be removed from a content server instance, but this only makes it unavailable from the Archiver application; the archive and batch files remain until you delete them from the file system.

Tip:
Archiver collections are normally compatible between different versions of Content Server. One possible exception would be User Configuration information that was archived from a pre-3.0 content server instance. The format of the Users database table changed in version 3.0, so this information might not be compatible between pre- and post-3.0 content servers.

Structure

An archive collection includes the following:

File or Directory

Description

collection.hda file

Specifies the archives that are included in the collection.

collection.mrk file

Internal file used by Archiver.

Archive directories

Each archive has a subdirectory in the collection.

Figure 7-8 Collection Structure

7.4.1.3 Batch Files

This section provides information about batch files.

Summary

A batch file is a text file that contains the file records for archived content items. Batch files describe the metadata for each exported revision.

- A new batch file subdirectory is created each time an archive is exported.

- Each batch file contains up to 1000 file records. If an export contains more than 1000 revisions, a new batch file is created.

Note:
Archiver batch files are not the same as the batch files that are used with the Batch Loader application.

Structure

A batch file subdirectory includes the following:

File or Directory

Description

Content files

A subdirectory named '1' in the batch file directory contains a vault structure that is copied from the source content server. If web-viewable files are being archived, this subdirectory also contains a weblayout structure.

Batch file

Specifies the metadata for each revision that was exported. Batch files are HDA files that are named with a unique number generated by Archiver. For example, 0335150414~1.hda.

docmetadefinition.hda file

Lists the custom metadata fields in the source content server (DocMetaDefinition database table). This file is used by Archiver to create import maps.

Figure 7-9 Batch File Structure

7.4.1.4 Archive Targets

You can use the archiver to archive the following content:

- Native files with associated standard metadata values

- Web-viewable files (.pdf, .html, and so forth)

- Metadata fields and changes

- User information fields

- Security groups (user attributes and settings)

- User updates

- Subscription types

- File formats

- Document types

- Content types

- User attributes (such as user login, full name, password, e-mail address, and so forth)

Note:
Content types and user attributes can be exported and imported manually, but cannot be transferred or archived automatically through replication. Table replication can be used, though, to replicate user information.

Caution:
Archiver cannot be used to move or copy data between two instances that share the same content server instance name (IDC_Name). To do so will corrupt the data on the target system.

7.4.1.5 Using Archive Logs

If you are experiencing Archiver problems, view the Archiver logs for more information.

Summary

The Archiver logs are listed by date and time. They are generated once per day when the first Archiver information status, irrecoverable error, or error occurs.

Click the Archiver Logs link on the Administration page to view information about imports, exports, and replications.

Click the link that appears for the desired log file. A table showing the type, date and time, and description of each action is displayed. It also includes the name of the content server instance that created the archive.

Figure 7-10 Archive Log File

Log Entries

The following types of archiver log entries are generated:

- Info: Displays basic status information. For example, status information is logged when an export and an import starts and finishes.

- Error: Displays user/administration errors that occur but do not stop the software from functioning. For example, an error is logged if there is no file information for a content item that you are trying to export.

- Fatal: Displays errors that stop the software from functioning. For example, an irrecoverable error is logged if the content server cannot access the database. Check the connection string, user name, and password.

7.4.2 Managing Archives

After archives are created, they can be added to collections and manipulated as a group.

- "Creating a New Archive"

- "Copying an Existing Archive"

- "Creating a New Archive by Copying"

- "Deleting an Archive"

7.4.2.1 Creating a New Archive

To create a new, undefined archive:

1. Display Main Archiver Screen in either standalone or browser mode.

2. If necessary, open the collection where you want to create the new archive. See "Opening a Collection".

3. From Edit, select Add.
The Add Archive Screen is displayed.

4. Enter the archive name and description. The archive name cannot contain spaces.

5. Click OK.

7.4.2.2 Copying an Existing Archive

To copy an existing archive to a different directory location:

Note:
This procedure copies the files in an archive. It does not create a new collection or update the collection.hda file if the archive is copied to a collection directory.

1. Display the archiver in standalone mode.

2. If necessary, open the collection that contains the archive to be copied. See "Opening a Collection".

3. Select the archive to be copied.

4. From Edit, select Copy To.
The Copy Archive Screen is displayed.

5. Accept the original archive name, or change the name as necessary.

6. In the Copy Archive To Directory field, enter the directory path where the archive will be copied.

7. Click OK.
The archive files are copied to the specified directory.

7.4.2.3 Creating a New Archive by Copying

You can copy archives from your system for storage or to your system from another archive if you are using the Archiver standalone version.

To create a new archive in the current collection by copying an existing archive:

1. Display the archiver in standalone mode.

2. If necessary, open the collection where you want to create the new archive. See "Opening a Collection".

3. From Edit, select Add.
The Add Archive Screen is displayed.

4. Enter the archive name and description. The archive name cannot contain spaces.

5. Select the Copy From check box.

6. Click Browse.

7. Navigate to and select the desired archive file (archive.hda).

8. Click Open.

9. Click OK.
The archive files are copied to the default archive directory in the local content server instance.

7.4.2.4 Deleting an Archive

To delete an archive from a collection:

1. Open the archive collection.

2. Select the archive to delete in the Current Archives list.

3. From Edit, select Delete.
You are prompted to confirm the action.

4. Click OK.
The archive is deleted from the collection.

7.4.3 Managing Collections

Collections are a set of archives and are used to group archives for different archive functions.

Note:
The standalone version of the Archiver application is required to create new collections or browse the local file system to connect to new collections.

- "Opening a Collection"

- "Creating a Collection"

- "Removing a Collection"

- "Moving the Default Archive Collection"

7.4.3.1 Opening a Collection

To open an existing archive collection:

1. Display the Archiver in standalone mode.

2. From Options, select Open Archive Collection.
The Open Archive Collection Screen is displayed, with the default collection and any other connected collections listed.

3. Select the collection from the list, or browse to a new collection as follows:
To select the collection from a shared file system location (standalone Archiver only):

1. Click Browse Local. The Find Archive Collection Definition File Screen is displayed.

2. Navigate to and select the collection HDA file.

3. Click Open.

To select the collection from a remote content server instance:

1. Click Browse Proxied.
The Browse for Proxied Collection Screen is displayed. The list includes all content server instances to which an outgoing provider has been set up.

2. Select the content server instance in the Proxied Servers list.

3. Select the collection in the Collections list.

4. Click OK.

4. Click Open.
The Browse To Archiver Collection Screen is displayed.

7.4.3.2 Creating a Collection

To create a new archive collection:

Note:
You can create a new collection only on the local content server instance using the standalone Archiver.

1. Display the archiver interface in standalone mode.

2. From Options, select Open Archive Collection.
The Open Archive Collection Screen is displayed.

3. Click Browse Local.
The Find Archive Collection Definition File Screen is displayed.

4. Navigate to and select the directory where you want to create the new collection.

5. Enter a file name for the new collection (collection.hda is the default).

6. Click Open.
You are prompted to create a collection definition (HDA) file.

7. Click Yes.
The Browse To Archiver Collection Screen is displayed.

8. Enter a collection name in the Name field.

- Collection names cannot contain spaces.

- Use the same name for a collection and its directory to make navigation easier.

9. Enter the directory path for the weblayout and vault directories in the Web Directory and Vault Directory fields.

- Use the same path style as shown in the Location field.

- To find the directory paths, display the Configuration Information Page.

10. Click OK.
The new collection is shown in the Open Archive Collection screen.

11. Click Open to open the new collection.

7.4.3.3 Removing a Collection

To remove an archive collection:

Note:
You cannot remove the default collection.

1. Select Options, and then click Open Archive Collection.
The Open Archive Collection Screen is displayed.

2. Select the collection to be removed.

3. Click Remove.
You are prompted to confirm the action.

4. Click OK.

The collection is removed from the content server instance. (The collection and archive files remain in the file system, and must be deleted manually.)

7.4.3.4 Moving the Default Archive Collection

You can change the file system location of the default archive collection by moving the collection and pointing the content server to the new location. For example, you might want to keep all of your archive data on a separate drive from the program files for easier backup and expansion.

Note:
The default collection is the /archives/ directory.

To move the default archive collection:

1. For data safety, close any standalone Archiver applications and stop the content server.

2. Add the CollectionLocation configuration variable to the DomainHome/ucm/cs/bin/intradoc.cfg file:

CollectionLocation=path

3. To maintain the previously created archives for the default collection, move the contents of the /archives/ directory to the new location you specified in the CollectionLocation setting.
If you do not move the contents, the system creates an empty collection.

4. Start the content server.

Note:
The content server will re-create the default Domain_home/ucm/cs/archives/ directory when it is restarted, but the Archiver will default to using the collection in the new location.

7.4.4 Managing Batch Files

A batch file describes the metadata for exported revisions. A batch file is created each time the archiver performs an export.

- "Removing Revisions from a Batch File"

- "Deleting a Batch File"

7.4.4.1 Removing Revisions from a Batch File

To remove individual revisions from a batch file:

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. Click View Batch Files on the Main Archiver Screen.
The View Batch Files Screen is displayed.

4. Select the batch file.

5. Click Edit.
The View Exported Content Items Screen is displayed.

6. Use the Filter element and the navigation buttons to display the revision to be deleted.

7. Select the revision to be deleted.

8. Click Delete.

The Status changes to Deleted for the selected revision.

9. Repeat steps 7 and 8 to delete additional revisions.

10. To undo the last deletion, click Undo. To return all deleted revisions to Archived status, click Refresh.

11. Click Apply to delete the specified revisions.

12. Click Close.

7.4.4.2 Deleting a Batch File

To delete a batch file from an archive:

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. Click View Batch Files on the Archiver (General Tab).
The View Batch Files Screen is displayed.

4. Select the batch file to delete.

5. Click Delete.
You are prompted to confirm the action.

6. Click OK.
The batch file is deleted from the archive.

7. Specify whether to replace existing batch files upon export:

- To delete all existing batch files when the next export is initiated, select the Replace Existing Export Files check box.

- To leave existing batch files in place when the next export is initiated, clear the Replace Existing Export Files check box.

8. Specify which files to export:

- To export the native (vault) and web-viewable (weblayout) files, select the Copy Web Content check box.

- To export only the native (vault) files, clear the Copy Web Content check box.

9. Click OK.
The export options are displayed in the Export Options section of the General tab.

7.5 Exporting Data in Archives

The Export function is used to copy native and web-viewable files out of the content server instance for backup, storage, or import to another content server instance. You can also export content types and user attributes. Note that this is a copy only; the original content remains.

- "About Exporting"

- "Managing Exports"

7.5.1 About Exporting

You can export revisions that are in RELEASED, DONE, EXPIRED, and GENWWW status. You cannot export revisions that are in an active workflow (REVIEW, EDIT, or PENDING status) or that are DELETED.

- "Export Uses"

- "Export Methods"

7.5.1.1 Export Uses

Typical uses for the Export function include:

- Copying files from an Intranet to make them available to an Extranet for vendor or customer viewing.

- Creating an archive of content items that will then be imported back to the same instance with different metadata.

- Removing content from the content server for permanent or temporary storage. For example, if space becomes limited or performance drops, you could remove all but the latest revision of each file.

- Copying files, content types, and user attributes from a development content server instance for use in a production instance.

Caution:
Do not use Archiver as your primary method of disaster recovery; use standard backup systems for the database and file system.

7.5.1.2 Export Methods

After you set up the export criteria, you can export archives in the following ways:

- Manual: A one-time export initiated from Archiver by an administrator. This creates an archive on the local content server instance.

- Automatic (Replication): Export to a local archive is initiated automatically whenever a content item that meets the export criteria is indexed.

"Manually Exporting" and "Replicating Files" discuss these processes in more detail.

Note:
You can export expired revisions manually, but expired revisions do not get exported automatically.

7.5.2 Managing Exports

This section provides information about typical tasks used in managing exports.

- "Manually Exporting"

- "Creating a Content Item Export Query"

- "Exporting Configuration Information"

- "Adding a Table to an Archive"

- "Editing the Archive Properties of a Table"

- "Creating a Table Export Query"

- "Setting Export Options"

- "Initiating the Export"

7.5.2.1 Manually Exporting

To export content manually:

1. Create an archive where the exported content server data will be stored. See "Creating a New Archive".

2. In the Current Archives list, select the archive.

3. Create an export query. See "Creating a Content Item Export Query".

4. Set configuration information export options. See "Exporting Configuration Information".

5. Set the general export options. See "Setting Export Options".

6. Initiate the export. See "Initiating the Export".

7.5.2.2 Creating a Content Item Export Query

Export queries define which revisions will be exported. Follow these steps to create an export query:

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. Click the Main Archiver Export Screen.

4. Click Edit in the Export Query (Content) section.
The Edit Export Query (Content) Screen is displayed.

5. Select a metadata field from the Field list.

6. Select an Operator from the list.

- The available operators depend on which Field is selected.

- The available operators map to basic SQL query operators. To use other SQL query operators, create a basic expression and then edit it in the Custom Query Expression check box (see step 10).

7. Enter the criteria in the Value field.
Depending on the option selected in the Field list, you can enter text directly, click the Select button and select from the available values, or select directly from a list of the available values.

8. Click Add.

The query expression is added to the Query Expression box, and the SQL version of the query expression is displayed in the Custom Query Expression box.

9. To add to the query expression, repeat steps 5 through 8. By default, each part of the expression is added using an AND operator.
To update an existing query, select the line to be changed in the Query Expression box and edit the Field, Operator, and Value fields as necessary. Click Update. The specified query expression replaces the selected line.

To delete a line from the query expression, select the line to be deleted in the Query Expression box. Click Delete. The selected line is deleted.

10. To edit the SQL expression directly:

1. Select the Custom Query Expression check box.

2. Edit the text in the Custom Query Expression box.
You can use Idoc Script in the query expression. For example, to archive content more than one year old, you could use <$dateCurrent(-365)$> as the Release Date value. See the Oracle Fusion Middleware Idoc Script Reference Guide for more information.

Caution:
If you clear the Custom Query Expression check box, the query expression reverts to its original definition; all modifications will be lost.

11. Specify whether to export revisions based on the last export date:

- To export only revisions that have been released since the last export, select the Export Revisions with Release Date later than most recent Export Date check box.

- To export all revisions, clear the Export Revisions with Release Date later than most recent Export Date check box.

12. Specify whether to export revisions that were published to the content server by Oracle Content Publisher:

- To export published revisions, select the Allow Export of Published Revisions check box.

- To export only unpublished revisions, clear the Allow Export of Published Revisions check box.

13. Specify which revisions to export:

- To export all revisions of each content item, select the All Selected Revisions option.

- To export only the latest revision of each content item, select the Latest Revisions option.

- To export all revisions except the most recent, select the Not Latest Revisions option.

- To export the most recent revision that matches the query, select the Single Revision Replication option. See "Single Revision Replications" for details about how this option affects the replication process.

Caution:
Do not use the Latest Revision option and automatic replication. These options, used in conjunction, can cause unpredictable archive behavior. See "Replicating Files" for more details about automatic replication.

14. Click OK.
The export query is displayed in the Export Query box on the Content tab.

15. To see a list of revisions that will be included in the export, click Preview.
The Previewing Export Queries (Content) Screen is displayed.

Note:
Although an unlimited number of revisions can be exported, a maximum of 100 revisions can be displayed in the Content Satisfying the Export Query screen. Use the Filter and Release Date since features to display subsets of the list as necessary.

16. Review the list to ensure that the export includes the intended revisions.

17. Click Close.

7.5.2.3 Exporting Configuration Information

To export content type and user attributes:

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. Click the Main Archiver Export Screen.

4. Click Edit in the Additional Data section. The Edit Additional Data Screen is displayed.

5. To export content types, select the Export Content Configuration Information check box.

6. To export user data, select the Export User Configuration Information check box.

7. Click OK.
The configuration information options are displayed in the Additional Data section of the Export Data tab.

7.5.2.4 Adding a Table to an Archive

To add a table to an archive:

1. Click the Main Archiver Export Screen (Table).

2. Select an archive from the Current Archives list.

3. Click Add.
The Add New/Edit Table Screen is displayed.

4. Complete the fields as appropriate. These fields are used to export the parent/child relationship in any tables used in schemas.

5. Click OK.
The table is added to the Table list on the Table tab.

Caution:
When exporting tables, ensure that the column names are the same if you are creating a relationship between two tables. If tables are imported individually, without assigning a relationship, it is not essential to match the column names. But if tables are imported in a relationship, the column names should be the same.

7.5.2.5 Editing the Archive Properties of a Table

To edit the archive properties of a table:

1. Click the Main Archiver Export Screen (Table).

2. Select an archive from the Current Archives list.

3. Select a table from the Table list.

4. Click Edit.
The Add New/Edit Table Screen is displayed.

5. Edit the fields as appropriate.

6. Click OK.

7.5.2.6 Creating a Table Export Query

To create a query that defines which tables will be exported:

1. Click the Main Archiver Export Screen (Table).

2. Select a table from the Table list.

3. Click Edit in the Export Query section.
The Edit Export Query (Table) Screen is displayed.

4. Select a metadata field from the Field list.

5. Select an Operator from the list.

- The available operators depend on which Field is selected.

- The available operators map to basic SQL query operators. To use other SQL query operators, create a basic expression and then edit it in the Custom Query Expression check box (see step 11).

6. Enter the criteria in the Value field.

7. Click Add.

The query expression is added to the Query Expression box, and the SQL version of the query expression is displayed in the Custom Query Expression box.

8. To add to the query expression, repeat steps 4 through 7. By default, each part of the expression is added using an AND operator.

9. To update an existing query:

1. Select the line to be changed in the Query Expression box.

2. Edit the Field, Operator, and Value fields as necessary.

3. Click Update.
The specified query expression replaces the selected line.

10. To delete a line from the query expression:

1. Select the line to be deleted in the Query Expression box.

2. Click Delete.
The selected line is deleted.

11. To edit the SQL expression directly:

1. Select the Custom Query Expression check box.

2. Edit the text in the Custom Query Expression box. You can use Idoc Script in the query expression. See the Oracle Fusion Middleware Idoc Script Reference Guide for more information.

Caution:
If you clear the Custom Query Expression check box, the query expression reverts to its original definition; all modifications will be lost.

12. Click OK.
The export query is displayed in the Export Query box on the Table tab.

13. To see a list of tables that will be included in the export, click Preview.
The Previewing Export Queries (Content) Screen is displayed.

Note:
Although an unlimited number of tables can be exported, a maximum of 100 tables can be displayed in the Content Satisfying the Export Query screen. Use the Filter and Release Date since features to display subsets of the list as necessary.

14. Review the list to ensure that the export includes the intended revisions.

15. Click Close.

7.5.2.7 Setting Export Options

To set general export options:

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. Click the Main Archiver Screen.

4. Click Edit in the Export Options section. The Edit Export Options Screen is displayed.

5. Specify whether to replace existing batch files upon export:

- To delete all existing batch files when the next export is initiated, select the Replace Existing Export Files check box.

- To leave existing batch files in place when the next export is initiated, clear the Replace Existing Export Files check box.

6. Specify which files to export:

- To export the native (vault) and web-viewable (weblayout) files, select the Copy Web Content check box.

- To export only the native (vault) files, clear the Copy Web Content check box.

7. Specify whether to export content or not:

- To export only tables, select the Export Table Only check box.

- To export content items, clear the check box.

8. Click OK.
The export options are displayed in the Export Options section of the General tab.

7.5.2.8 Initiating the Export

To manually export content and configuration information:

1. Open Archiver for the content server that contains the files you want to export.

2. Open the archive collection. See "Opening a Collection".

3. Select the archive to export to in the Current Archives list.

4. From Actions, select Export.
The Export Archive Screen is displayed.

Note:
If the Export option is disabled, the archive is being exported automatically. You must disable the automatic replication to perform a manual export. See "Replicating Files" for details.

5. Specify whether to delete the revisions from the content server instance after the export is successfully completed:

- To delete revisions after export, select the Delete revisions after successful archive check box.

- To leave revisions in the content server after export, clear the Delete revisions after successful archive check box.

6. Click OK.
The export process is initiated, and the status bar at the bottom of the Archiver screen displays progress messages.

7.6 Importing Data

Archives can be imported according to specified rules and at specified times. The data in the files can be mapped to fields in the receiving content server but care should be taken that the correct rules are applied during import.

- "Imported Files"

- "Import Rules"

- "Import Process"

7.6.1 Imported Files

The Import function is used to retrieve files and content server information from an exported archive. Importing is typically used to obtain a copy of content from another content server or to restore data that has been in storage.

The content server instance to which you are importing must have the same metadata fields, security groups, and accounts as the instance that the archive was exported from. Errors can result if there are mismatches.

Caution:
Do not use Archiver as your primary method of disaster recovery; use standard backup systems for the database and file system.

Note:
Imported revisions will not enter a workflow upon import, even if they meet the criteria for an active workflow.

Before beginning the import process, consider the following points:

- Determine the method to be used, either manual or automatic.

- Determine the rules to be used for updating.

- Determine the mapping and import options.

- Test your process by importing selected revisions.

This section covers these topics:

- "Import Uses"

- "Import Methods"

7.6.1.1 Import Uses

Typical uses for the Import function include:

- Placing data archived from an Intranet on an Extranet for vendor or customer viewing.

- Changing metadata for a large number of content items. For example, if an employee leaves the organization, you could export all of their content items and then import them with another user specified as the Author.

- Restoring content that was inadvertently deleted or configuration information that was inadvertently changed.

- Copying files, content types, and user attributes from a development content server archive to a production instance.

7.6.1.2 Import Methods

You can import archives in the following ways:

- Manual: A one-time import initiated from Archiver by an administrator.

- Automatic (Replication): Import from a local archive is initiated automatically, about once per minute.

See "Import Process" and "Replicating Files" for more information.

7.6.2 Import Rules

An import rule defines how revisions are added, replaced, or deleted during import.

- During import, Archiver compares each revision being imported with the existing revisions in the importing content server. The import rule specifies which action to take (add, replace, delete, or ignore), depending on comparison of the following information:

- Content ID

- Original content server

- Revision number

- Release date

- Only one import rule can be selected for each import of an archive.

This section covers these topics:

- "Update Import Rule"

- "Insert Revision Import Rule"

- "Insert Create Import Rule"

- "Delete Revision Import Rule"

- "Delete All Revisions Import Rule"

7.6.2.1 Update Import Rule

Use the Update import rule to replace existing revisions and insert new revisions.

Caution:
The Update import rule will replace existing revisions without saving the existing files. Be extremely careful when importing so you do not accidentally replace content you meant to keep.

- If an imported revision has a different Content ID (dDocName) than any existing revision, the imported revision is inserted as a new revision.

- If an imported revision has the same Content ID (dDocName) as an existing revision, the imported revision is inserted, ignored, or replaces the latest existing revision.

Figure 7-11 Import Rules

7.6.2.2 Insert Revision Import Rule

The Insert Revision import rule imports only revisions that have both the most recent revision number and the most recent release date.

- If an imported revision has a different Content ID (dDocName) than any existing revision, the imported revision is inserted as a new revision.

- If an imported revision has the same Content ID (dDocName) as an existing revision, but has a different Revision ID (dRevisionID) than any existing revision and a later release date (dInDate) than that of the latest existing revision, the imported revision is inserted as a new revision with a new revision label.

Figure 7-12 Import Rule: Insert Revision

7.6.2.3 Insert Create Import Rule

The Insert Create import rule imports only revisions that have the most recent release date, regardless of the revision number.

- If an imported revision has a different Content ID (dDocName) than any existing revision, the imported revision is inserted as a new revision.

- If an imported revision has the same Content ID (dDocName) as an existing revision, and the release date (dInDate) of the imported revision is later than that of the latest existing revision, the imported revision is inserted as a new revision with a new revision label.

Figure 7-13 Import Rule: Insert Create

7.6.2.4 Delete Revision Import Rule

Use the Delete Revision import rule to delete individual revisions.

- If an imported revision has the same Content ID (dDocName) and Revision ID (dRevisionID) as an existing revision, the existing revision is deleted.

Figure 7-14 Import Rule: Delete Revision

7.6.2.5 Delete All Revisions Import Rule

Use the Delete All Revisions import rule to delete all revisions of a content item.

- If an imported revision has the same Content ID (dDocName) as any existing revision, all existing revisions with that Content ID are deleted.

Figure 7-15 Import Rule: Delete All Revisions

7.6.3 Import Process

This section provides information about the import process and related tasks.

Tip:
To determine which archive contains the data you want to retrieve, you can prepare an Archive History report using the Web Layout Editor.
You can also examine the files generated by the archive at the file system level, but preparing a report is more efficient if you frequently need to find archived data.

Important:
If you are using Sybase and you want to import an archive, you must perform the following tasks:

1. Make sure you are logged into Content Server as an administrator.

2. Click Administration in the navigation menu on the left.

3. On the Administration Applets page, click Repository Manager.

4. Open the Indexer tab.

5. In the Automatic Update Cycle section, click Configure.

6. Make sure the Indexer Auto Updates check box is cleared.

7. Close Repository Manager.

8. Use Archiver to import the archive.

9. Open Repository Manager, and select the Indexer Auto Updates check box again.

This section covers these topics:

- "Importing Archived Data Manually"

- "Setting Field Maps"

- "Setting Value Maps"

- "Setting Import Options"

- "Importing an Individual Revision"

- "Initiating the Import"

7.6.3.1 Importing Archived Data Manually

1. In the Current Archives list, select the archive from which to retrieve data.

2. Review the batch files in the archive. If necessary, remove revisions from the batch files. See "Removing Revisions from a Batch File".

3. If you want to change metadata fields or values during the import, set up the field and value mappings. See "Setting Field Maps" and "Setting Value Maps".

4. Set the general import options. See "Setting Import Options".

5. Test the import mappings and rules on a few individual revisions. See "Importing an Individual Revision".

6. Initiate the import. See "Initiating the Import".

7.6.3.2 Setting Field Maps

Field maps specify how metadata values are copied from one metadata field to another during import. If you do not want to copy metadata values, do not specify any field maps.

To set up field maps:

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. Click the Import Maps Main Screen.

4. Click Edit in the Field Maps section.
The Edit Field Map/Edit Value Map Screen is displayed.

5. Click Browse For Fields.
The Browse for Fields/Value Screen is displayed.

6. Select a source for the list of available metadata fields:

- To retrieve the metadata fields from the local content server, select Local System.

- To retrieve the metadata fields from a batch file, select Batch and select a batch file from the list.

7. Click OK.
The Export Field option list is populated with the metadata fields that are associated with the content server or the selected batch file.

8. In the Export Field list, select the metadata field from which you want to copy metadata.

The selected metadata field is displayed in the Export Field. (You can also edit this field directly. Make sure to use the internal field name, such as dDocAuthor or xComments.)

9. In the Target Field list, select the metadata field you want the Export metadata to be copied to.

10. Click Add.

The mapping expression is added to the Field Maps box.

11. To add to the mapping expression, repeat steps 8 through 10.

12. To update an existing mapping expression:

1. Select the line to be changed in the Field Maps box.

2. Edit the Export Field and Target Field as necessary.

3. Click Update.
The specified mapping expression replaces the selected line.

13. To delete a line from the mapping expression:

1. Select the line to be deleted in the Field Maps box.

2. Click Delete.
The selected line is deleted.

14. Click OK.
During import, the values from the Export field replace any existing values in the Target field.

15. To test the results of your field maps, import a few individual revisions from an archive. See "Importing an Individual Revision".

7.6.3.3 Setting Value Maps

Value maps specify how specific metadata values are to be changed during import. If you do not want to change metadata values, do not specify any value maps.

To set up value maps:

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. Click the Import Maps Main Screen.

4. Click Edit in the Value Maps section.
The Edit Field Map/Edit Value Map Screen is displayed.

5. To change all metadata values for a particular field, select the All check box. Continue with step 11.

6. To change a specific metadata value, click Browse For Values.
The Browse for Fields/Value Screen is displayed.

7. Select a batch file from the From Batch File list.

8. Select a metadata field from the From Field list.

9. Click OK.
The Input Value option list is populated with the values that are associated with the selected metadata field in the selected batch file.

10. In the Input Value list, select the metadata value to be changed.

11. In the Field list, select the metadata field to be changed.

12. In the Output Value field, enter the new metadata value.

- You can use Idoc Script in the output value. For example, to set the expiration date one week in the future for all imported revisions, you could use <dateCurrent(7)$>. See the Oracle Fusion Middleware Idoc Script Reference Guide for more information.

- To delete all values from the input metadata field, leave the output value blank.

13. Click Add.

The mapping expression is added to the Value Maps box.

14. To add to the mapping expression, repeat steps 5 through 13.

15. To update an existing mapping expression:

1. Select the line to be changed in the Value Maps box.

2. Edit the Input Value, Field, and Target Value as necessary.

3. Click Update.
The specified mapping expression replaces the selected line.

16. To delete a line from the mapping expression:

1. Select the line to be deleted in the Value Maps box.

2. Click Delete.
The selected line is deleted.

17. Click OK.
During import, the specified Input Values in the specified metadata Fields will be replaced with the Target Values.

18. To test the results of your value maps, import a few individual revisions from an archive. See "Importing an Individual Revision".

7.6.3.4 Setting Import Options

To set general import options:

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. Click the Archiver (General Tab).

4. Click Edit in the Import Options section.
The Edit Import Options (Select Rules) Screen is displayed.

5. Select an option in the Override Import Rules list to specify how existing revisions are added, replaced, or deleted during import. See "Import Rules" for detailed descriptions.

Caution:
The Update import rule will replace existing revisions without saving the existing files. Be extremely careful when importing so that you do not accidentally replace content you meant to keep.

6. Specify whether option list values are validated during import:

- To import only revisions with valid option list values (validated option lists only), select the Import only revisions with valid option list values check box.

- To skip option list validation, clear the Import only revisions with valid option list values check box.

Tip:
The Import only revisions with valid option list values check box applies to all validated option lists. If you want to validate some option list fields but not all of them, you can change the Option List Type in the Configuration Manager. Use Select List Validated for option lists you want to validate; use Select List Not Validated for option lists you do not want to validate.

7. Specify whether to recalculate times in metadata date fields to reflect the time zone of the target content server:

- To recalculate times, select the Translate the dates to the current system time zone check box.
For example, if the time zone of the source (export) content server is Central Standard Time and the time zone of the target (import) content server is Eastern Standard Time, the release times, create times, expiration times, and any custom times will be changed to one hour later.

- To leave times unchanged, clear the Translate the dates to the current system time zone check box.

8. Click OK.

9. To test the results of your import options, import a few individual revisions from an archive. See "Importing an Individual Revision".

7.6.3.5 Importing an Individual Revision

To import a specific revision:

Tip:
Before importing an entire batch file, use this procedure to import a few individual revisions to test the results of your import maps and rules.

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. On the Archiver (General Tab), click View Batch Files.
The Removing Revisions from a Batch File is displayed.

4. Select the batch file that contains the file you want to import.

5. Click Edit.
The View Exported Content Items Screen is displayed.

6. Use the Filter feature and the navigation buttons to display the revision to be imported.

7. Select the revision.

8. Click Import.
If the revision was imported successfully, a confirmation message is displayed.

7.6.3.6 Initiating the Import

To manually import content and configuration information:

1. Open Archiver for the content server that you want to import to.

2. Open the archive collection that you want to import from. (This collection must be accessible through the file system.) See "Opening a Collection".

3. Select the archive in the Current Archives list.

4. From Actions, select Import.
The Import Archive Screen is displayed.

5. Specify the information to be imported:

- To import content, select the Import Batched Revisions check box.

- To import content and tables, select the Import Tables check box.

Note:
The User Configuration and Content Configuration options are available only if the selected archive includes this information (users.hda or doctypes.hda file).

6. Click OK.
The import process is initiated, and the status bar at the bottom of the Archiver screen displays progress messages.

7.7 Transferring Files

The Transfer function is used to move or copy content from one content server to another over sockets.

- "File Transfer Overview"

- "Transfer Types"

- "Transferring Batch Files"

- "Managing Transfers"

7.7.1 File Transfer Overview

You can use the Transfer function to transfer files between content servers on a shared file system, but transfers do not require a shared file system. Transferring files between non-shared file systems requires an outgoing provider on the source content server instance.

Transfers will be successful only between Content Server 4.5 or newer systems.

Caution:
Archiver cannot be used to move or copy data between two instances that share the same content server instance name (IDC_Name). To do so will corrupt the data on the target system.

This section covers these topics:

- "Transfer Uses"

- "Transfer Methods"

- "Transfer Terms"

7.7.1.1 Transfer Uses

Typical uses for the Transfer function include:

- Exporting and importing over a firewall.

Note:
To transfer across a firewall, you might need to configure the firewall to permit the outgoing provider's socket to pass through it.

- Transferring content between content server instances in different physical locations (buildings, cities, or countries).

- Transferring content between content server instances using a shared drive. (A transfer over a file system share can handle large archives better than a socket transfer.)

- Avoiding the need to build an FTP or HTTP interface to move files from one file system to another.

- Combining the batch files from two archives into a single archive.

7.7.1.2 Transfer Methods

You can transfer files in the following ways:

- Manual Transfer: A one-time transfer initiated from Archiver by an administrator. This copies an archive to another archive.

- Automatic Transfer: Moving archive files to another archive is initiated automatically whenever the source archive is updated.

7.7.1.3 Transfer Terms

The following terms are related to the Transfer function:

- local archive: An archive that belongs to a local collection.

- local collection: A collection that the content server can reach by file access using a mapped or mounted network share.

- local transfer: A transfer between local archives. Both the source archive and the target archive are in a local collection.

- proxied: In Archiver, the term 'proxied' refers to any content server to which the local content server is connected through an outgoing provider.

- proxied archive: An archive that belongs to a proxied collection.

- proxied collection: A collection on another content server that the local content server can reach through an outgoing provider.

- pull transfer: A transfer over an outgoing provider that is owned by the proxied (remote) content server.

- push transfer: A transfer over an outgoing provider that is owned by the local content server.

- source archive: An archive that contains batch files to be transferred.

- target archive: An archive that receives transferred batch files.

- targetable archive: An archive that is enabled to be a target archive.

- transferring: The process of copying or moving batch files and their associated content files from one archive to another. There are three types of transfers: local, push, and pull.

- transfer owner: The content server instance that performs and monitors a transfer.

- transfer source: See source archive.

- transfer target: See target archive.

7.7.2 Transfer Types

This section provides information about the different transfer types, listed in order from simplest to most complex.

- "Local Transfer"

- "Pull Transfer"

- "Push Transfer"

7.7.2.1 Local Transfer

A local transfer is a transfer between local archives, which belong to collections that both the source and target content servers can reach through a mapped or a mounted drive. An outgoing provider is not required. This type of transfer is typically used to combine the batch files of two archives.

Note:
If you are transferring between content servers on a shared file system, the mapped or mounted drive must be available to both content servers. The computers must be on and logged in as a user who has system access to both content servers.

Figure 7-16 Local Transfer

7.7.2.2 Pull Transfer

A pull transfer is a transfer that is owned by the proxied (remote) content server, which is the instance that is the target of the outgoing provider.

- Multiple pull transfers can be concurrent.

- If you are running a pull transfer across a firewall, you might need to configure the firewall to permit the outgoing provider's socket to pass through it.

Note:
In Archiver, the term 'proxied' refers to any content server to which the local instance is connected through an outgoing provider. This does not have to be a proxied instance of the master content server.

Figure 7-17 Pull Transfer

7.7.2.3 Push Transfer

A push transfer is a transfer that is owned by the local content server, which is the instance on which the outgoing provider is set up.

- For performance monitoring of a push transfer, you also should set up an outgoing provider from the target (proxied) content server back to the source (local) content server. This 'talkback' provider can then notify the source content server when each transfer is complete. A push transfer will work without the talkback provider, but the source content server would not be aware of transfer completion or problems.

- Only one push transfer can be in progress at a time.

- If you are running a push transfer across a firewall, you might need to configure the firewall to permit the both providers' sockets to pass through it.

Figure 7-18 Push Transfer

7.7.3 Transferring Batch Files

This section provides information about transferring batch files.

Transfer Process

When a transfer is initiated, the following actions occur:

1. Each batch file in the archive is zipped together with its associated content files.

2. The Zip files are transferred to the target content server by a local file system move (local transfer) or by the outgoing provider (push or pull transfer).

3. The Zip files are unzipped and placed in the appropriate file system locations.

4. For an automated transfer, the batch files and their associated content files are removed from the source content server. For a manual transfer, the batch files and associated content files remain in the source content server.
The transferred archive is now available for import through the Archiver of the target content server.

Figure 7-19 The Transfer Process

Transfer Rules

The following list provides applicable transfer rules:

- If you are transferring between content servers on a shared file system, the mapped or mounted drive must be available to both content servers. The computers must be on and logged in as a user who has system access to both content servers.

- The content server that has an outgoing provider set up is considered the 'local' server, and the target content server for the outgoing provider is considered the 'proxied' server. Files are always transferred in the direction of the outgoing provider, from the local (source) instance to the proxied (target) instance.

- To transfer multiple archives from a content server, you must set up a separate outgoing provider from the local instance for each target instance.

- Only archives that are identified as 'targetable' can be transfer targets. When you are selecting a transfer target, the 'targetable' attribute can help you find the target archive quickly.

- At least one archive in the transfer must be local to the transfer owner. For example, you cannot set up a transfer between two content servers that is owned by a third content server.

- An archive can contain only one copy of each batch file. Therefore, if a batch file being transferred already exists in the target archive, the batch file and its associated content files will be ignored.

7.7.4 Managing Transfers

This section provides information about managing transfers.

- "Transfer Process"

- "Making an Archive Targetable"

- "Defining an Outgoing Transfer Provider"

- "Setting a Transfer Destination (Target)"

- "Initiating a Manual Transfer"

- "Deleting a Transfer"

7.7.4.1 Transfer Process

To transfer content between content servers:

1. In the source content server, create the archive to be transferred and set up an export to this archive. See "Manually Exporting".

2. In the target content server, create the archive to receive transferred content and make the target archive 'targetable.' See "Making an Archive Targetable".

3. Set up communications between content servers:

- If the source and target archives are on a shared file system, ensure that both computers are on and logged in as a user who has system access to both content servers.

- If the source and target archives are not on a shared file system, create an outgoing provider from the source content server to the target content server. See "Defining an Outgoing Transfer Provider".

4. From the source archive, specify the target archive. See "Setting a Transfer Destination (Target)".

5. Initiate the transfer. See "Initiating a Manual Transfer".
The batch files and content files are copied to the target archive.

7.7.4.2 Making an Archive Targetable

To indicate that an archive can receive transfers from other archives:

1. Open the archive collection that contains the target archive. See "Opening a Collection".

2. Select the target archive in the Current Archives list.

3. Click the Main Archiver Transfer Screen.

4. Click Edit in the Transfer Options section.
The Transfer Options Screen is displayed.

5. Select the Is Targetable check box.

6. Click OK.

7.7.4.3 Defining an Outgoing Transfer Provider

To create an outgoing provider for transfer purposes:

1. On the source content server, create an outgoing provider. Enter the following information:

Field

Description

Provider Name

Enter a name. This will become a subdirectory in the DomainHome/ucm/cs/data/providers/ directory.

Provider Description

Enter a user-friendly description, such as Transfer Provider.

Server Host Name

Enter the server host name of the target content server. For example, extranet_server.

Server Port

Enter a unique port number on which the provider will communicate with the target content server.

Instance Name

Enter the name of the target content server instance. For example, Master_on_extranet.

Relative Web Root

Enter the relative web root of the target content server instance. For example, /stellent/.

Proxied check box

Select this check box only if the target content server was installed as a proxy of the local (master) content server. See the Caution message below.

Caution:
Do not select this check box if the relative web root is the same for both content servers.

2. In the System Properties utility of the target content server, set the IP Address Filter or Hostname Filter to the IP address or host name of the source content server. (The IP Address Filter setting is recommended.)

3. If you are setting up a push transfer (transfer owned by the local content server), consider setting up a 'talkback' outgoing provider from the target content server back to the source content server.

4. If you are transferring across a firewall, configure the firewall to permit the outgoing providers' sockets to pass through it.

7.7.4.4 Setting a Transfer Destination (Target)

To specify the target archive to receive transferred content:

1. Open Archiver from the content server that will own the transfer.

- For a pull transfer, the transfer owner is the target (proxied) content server.

- For a push transfer, the transfer owner is the source (local) content server.

2. Open the archive collection that contains the source archive. See "Opening a Collection".

3. Select the source archive in the Current Archives list.

4. Click the Main Archiver Transfer Screen

5. Click Edit in the Transfer Destination section.
The Archive Collections Screen is displayed.

6. Select the collection that contains the target archive.

7. Select the target archive.

Note:
The target archive must be identified as targetable. See "Making an Archive Targetable".

8. Click OK.

7.7.4.5 Initiating a Manual Transfer

To transfer content manually:

1. Open Archiver on the source content server.

2. Open the archive collection that contains the source archive. See "Opening a Collection".

3. Select the source archive in the Current Archives list.

4. Select Actions, and then click Transfer.
The transfer process is initiated, and the status bar at the bottom of the Archiver screen displays progress messages.

7.7.4.6 Deleting a Transfer

This section provides information about the methods to delete a transfer.

Deleting a Transfer from the Transfer To Tab

To delete a transfer using this method:

1. Open the archive collection that contains the source archive. See "Opening a Collection".

2. Select the source archive in the Current Archives list.

3. Click the Main Archiver Transfer Screen.

4. Click Remove in the Transfer Destination section.
You are prompted to confirm the action.

5. Click Yes.

Deleting an Automated Transfer from the Automation for Instances Screen

To delete a transfer using this method:

1. Open the archive collection. See "Opening a Collection".

2. Select Options, and then click View Automation For Instance.
The Automation Screen is displayed.

3. Click the Transfers tab.

4. Select the automated transfer to delete.

5. Click Remove.
The automated transfer is removed from the list.

7.8 Replicating Files

The Replication function is used to automate the Archiver's export, import, and transfer functions.

- "Replication Overview"

- "Managing Replication"

7.8.1 Replication Overview

If you are automating an import using replication, each batch file is removed as soon as the automatic import is complete. However, you can view the archiving results by preparing an Archive History report using the Web Layout Editor.

If you are replicating files to a contribution server, you should map the Security Group and/or Account field so that users have only Read permission to the imported files. Otherwise, changed files in the importing instance could be overwritten by exported files during a later replication cycle.

For performance reasons, replication is not recommended for large archives (approximately 20,000 files or more). Export and import of large archives should be run manually, during periods of non-peak usage if possible.

Caution:
Archiver cannot be used to move or copy data between two instances that share the same content server instance name (IDC_Name). To do so corrupts the data on the target system.

This section covers these topics:

- "Single Revision Replications"

- "Replication Uses"

- "Replication Methods"

7.8.1.1 Single Revision Replications

When using the Single Revision Replication option on the Edit Export Query (Content) Screen, be aware of the following considerations:

- If the new document matches the archiver query on checkin, it is archived. If it does not match the query, nothing happens.

- If a document has multiple revisions and the most recent matching revision is deleted or updated so it no longer matches the query, the next most recent matching revision of that document is replicated. If no revisions match the query, that document is deleted through replication.

- If a system (A) is replicating to system (B) and the Single Revision Replication option is used, system B will at any given time only have one revision of each document. The revLabel of each revision is 1, no matter what the revLabel was on the document that was replicated.

This archiving option allows an administrator to create a staging system and a production system. The staging system can archive all documents that have a specific metadata field set to 1. The production system will always have the most recent revision of each document that has this metadata flag set. Setting this flag to 0 on the staging system removes it from the production system and rolls it back to the next most recent revision with that metadata field set to 1.

7.8.1.2 Replication Uses

Typical uses for the Replication function include:

- Automatically exporting from one content server instance and importing to another content server instance to synchronize two Web sites.

- Copying content automatically between two contribution/consumption servers.

- Automatically moving certain documents from a contribution server to a higher-security content server.

- Automatically moving old content to a storage location.

7.8.1.3 Replication Methods

You can automate Archiver functions in the following ways:

- Automatic Export: Export to a local archive is initiated automatically whenever a content item that meets the export criteria is indexed.

- Automatic Import: Import from a local archive is initiated automatically, about once per minute.

- Automatic Transfer: Moving archive files to a different content server instance over sockets is initiated automatically whenever the source archive is updated.

Note:
You can export expired revisions manually, but expired revisions do not get exported automatically.

7.8.2 Managing Replication

Several tasks are involved in managing the replication process, including setting up automatic exports, imports and transfers. This section provides information about these tasks.

- "Setting Up Automatic Export"

- "Setting Up Automatic Import"

- "Setting Up Automatic Transfer"

- "Disabling Automatic Import"

- "Disabling Automatic Export"

- "Disabling Automatic Transfer"

- "Deleting a Registered Exporter"

7.8.2.1 Setting Up Automatic Export

To set up an automatic export:

1. Set up the export and run a manual export. See "Manually Exporting".

2. Open Archiver on the content server that content is to be exported from.

3. Open the archive collection.

4. Select the archive to export to automatically in the Current Archives list.

5. Click the Replication tab.

6. Click Edit.
The Registered Exporter Screen is displayed.

7. Select the Enable Automated Export check box.

8. Click Register.
The current collection is added to the Registered Exporters box.

9. Click OK.
Each revision that meets the export criteria will be exported to this archive when it is indexed. The batch file is removed as soon as each export is complete.

Note:
You can export expired revisions manually, but expired revisions do not get exported automatically.

7.8.2.2 Setting Up Automatic Import

To set up an automatic import:

1. Set up the import and run a manual import. See "Import Process".

2. Open Archiver on the content server that the archive is to be imported to.

3. Open the archive collection.

4. Select the archive to import automatically in the Current Archives list.

5. Click the Replication tab.

6. Click Register Self.
You are prompted to confirm the action.

7. Click OK.
The selected archive will be imported automatically, about once per minute. All source batch files are removed as soon as each import is complete.

Note:
The Replication function does not import content types and user attributes.

7.8.2.3 Setting Up Automatic Transfer

To set up an automatic transfer:

1. Set up the transfer and run a manual transfer. See "File Transfer Overview".

2. Open Archiver on the source content server.

3. Open the archive collection.

4. Select the source archive in the Current Archives list.

5. Click the Transfer To tab.

6. Click Edit.
The Transfer Options Screen is displayed.

7. Select the Is Transfer Automated check box.

8. Click OK.

9. Test the automatic transfer:

1. In the source content server, check in a new document that meets the export criteria.

2. If the export is automated, wait until automated export occurs after indexing. Otherwise, export the source archive manually.
The archive should be transferred to the target content server within a few minutes.

Note:
The Replication function does not import content types and user attributes.

7.8.2.4 Disabling Automatic Import

This section provides information about the methods to disable an automatic import.

Unregistering an Importer from the Replication Tab

To disable an automatic import using this method:

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. Click the Replication tab.

4. Click Unregister.
Automatic importing from the selected archive is disabled.

Disabling a Registered Importer from the Automation for Instance Screen

To disable an automatic import using this method:

1. Open the archive collection. See "Opening a Collection".

2. From Options, select View Automation For Instance.
The Automation for Instance Screen is displayed.

3. Click the Importers tab.

4. Select the registered importer to delete.

5. Click Remove.
The registered importer is removed from the list.

7.8.2.5 Disabling Automatic Export

To disable automatic export:

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. Click the Replication tab.

4. Click Edit.
The Registered Exporter Screen is displayed.

5. Clear the Enable Automated Export check box.

6. Click OK.
Automatic exporting of the selected archive is disabled.

7.8.2.6 Disabling Automatic Transfer

To disable automatic transfer:

1. Open Archiver on the source content server.

2. Open the source archive collection. See "Opening a Collection".

3. Select the source archive in the Current Archives list.

4. Click the Transfer To tab.

5. Click Edit.
The Transfer Options Screen is displayed.

6. Clear the Is Transfer Automated check box.

7. Click OK.
Automatic transfer of the selected archive is disabled.

7.8.2.7 Deleting a Registered Exporter

This section provides information about the methods to delete a registered exporter.

Deleting a Registered Exporter from the Replication Tab

To delete a registered exporter using this method:

1. Open the archive collection. See "Opening a Collection".

2. Select the archive in the Current Archives list.

3. Click the Replication tab.

4. Click Edit.
The Registered Exporter Screen is displayed.

5. Select the Enable Automated Export check box.

6. Select the content server instance to delete in the Registered Exporters list.

7. Click Remove.
The registered exporter is removed from the list.

8. Click OK.

Deleting a Registered Exporter from the Automation for Instance Screen

To delete a registered exporter using this method:

1. Open the archive collection. See "Opening a Collection".

2. From Options, select View Automation For Instance.
The Automation for Instance Screen is displayed.

3. Select the registered exporter to delete.

4. Click Remove.
The registered exporter is removed from the list.

7.9 Archive and Migration Strategies

This section provides information about several typical archiving and migration strategies.

Note:
All of the scenarios described in this section can be run manually or automatically (through replication).

This section covers these topics:

- "Export"

- "Import"

- "Self Export/Import"

- "One-to-One Archiving"

- "One-to-Many Archiving"

- "Many-to-One Archiving"

- "Archiver Examples"

- "Configuration Migration Tips"

7.9.1 Export

This section provides information about exporting.

Summary

A simple export is typically used to:

- Store and later remove outdated content on a file system.

- Store content on a file system for later retrieval.

- Retain a 'snapshot' of a content server at a certain date and time.

Configurations

The following are possible export-only configurations, shown in order from most to least typical:

- Export to a collection on an external file system.

- Export to one of the content server's own collections.

7.9.2 Import

This section provides information about importing.

Summary

A simple import is typically used to:

- Retrieve content from storage after an unintended deletion.

- Restore content from an archived 'snapshot' of a content server.

Configurations

The following are possible import-only configurations, shown in order from most to least typical:

- Import from a collection on an external file system.

- Import from one of the content server's own collections.

7.9.3 Self Export/Import

This section provides information about self export.

Summary

Self export/import is typically used to change content metadata to new values.

Configurations

The following are possible self export/import configurations, shown in order from most to least typical:

- Export to and import from one of the content server's own collections.

- Export to and import from a collection on an external file system.

7.9.4 One-to-One Archiving

This section provides information about one-to-one archiving.

Summary

One-to-one archiving is used to copy or move content from one content server to another.

Configurations

The following are possible one-to-one archiving configurations, shown in order from most to least typical:

- Export, transfer, and import over sockets.

- Export, transfer, and import on a shared file system.

- Export to and import from a collection on a shared external file system.

- Export to the source content server's collection and import directly from that collection on a shared file system.

- Export from the source content server directly to a collection on the target content server and import from that collection on a shared file system.

7.9.5 One-to-Many Archiving

This section provides information about one-to-many archiving.

Summary

One-to-many archiving is typically used to copy or move content from a contribution server to consumption servers.

Configurations

The following are possible one-to-many archiving configurations, shown in order from most to least typical:

- Export, transfer, and import over sockets.
When this configuration is automated using replication, a separate export archive is required for each target server because the source files are deleted upon transfer. However, for manual transfer, you could transfer a single archive to multiple targets.

- Export, transfer, and import on a shared file system.
When this configuration is automated using replication, a separate export archive is required for each target server because the source files are deleted upon transfer. However, for manual transfer, you could transfer a single archive to multiple targets.

- Export to and import from a collection on a shared external file system.
When this configuration is automated using replication, a separate export archive is required for each target server because the source files are deleted upon import. However, for manual import, you could import a single archive from multiple targets.

- Export to the source content server's collection and import directly from that collection on a shared file system.
When this configuration is automated using replication, a separate export archive is required for each target server because the source files are deleted upon import. However, for manual import, you could import a single archive from multiple targets.

- Export from the source content server directly to collections on the target content servers and import from those collections on a shared file system.

7.9.6 Many-to-One Archiving

This section provides information about many-to-one archiving.

Summary

Many-to-one archiving is typically used to:

- Copy or move content from several contribution servers to one consumption server.

- Move sensitive content from several contribution servers to a more secure contribution server.

Configurations

The following are possible many-to-one archiving configurations, shown in order from most to least typical:

- Export, transfer, and import over sockets.

- Export, transfer, and import on a shared file system.

- Export to and import from a collection on a shared external file system.

- Export to the source content servers' collections and import directly from those collections on a shared file system.

- Export from the source content servers directly to a collection on the target content server and import from that collection on a shared file system.

7.9.7 Archiver Examples

This section provides examples that illustrate how to use Archiver to solve common business problems.

- "Copying a Content Server Instance to a Laptop"

- "Transferring by Content Type and Author"

- "Changing Metadata Fields"

- "Adding Content ID Prefixes"

- "Changing Release Dates"

7.9.7.1 Copying a Content Server Instance to a Laptop

In this example, you need to set up a laptop computer with a copy of a content server instance for a colleague who will be traveling.

This procedure assumes that the source content server and the laptop computer have access to the same file system, and that the laptop computer has Content Server installed.

1. Open Archiver on the source content server.

2. Create a new archive.

3. Because you want to export all content, you do not need to create an export query.

4. To limit the file size of the archive, select the Latest Revisions option on the Edit Export Query screen.

5. If content types and user attributes need to be copied to the laptop system, select Content Configuration and User Configuration on the Export Data tab.

6. Set export options from the General tab:

- To save space on the local system, select Replace Existing Export Files.

- If your colleague needs web-viewable files, select Copy Web Content.

7. Initiate the export manually.

8. Open Archiver on the laptop content server.

9. Open the source collection and select the archive to import.

10. If content type and user attributes were exported, select these options on the Import Archive screen.

11. Initiate the import manually.

7.9.7.2 Transferring by Content Type and Author

In this example, you have a contribution content server where users submit content. You want to automatically archive HR content that is contributed by JChang to a content server in another building that serves as a Human Resources portal.

This procedure assumes that the two content servers do not have access to a shared file system, and that the Human Resources portal server should contain only the latest revision of each content item.

Set up an automated export on the Contribution content server:

1. Create an archive.

2. Set these export queries for the archive:

Field

Operator

Value

Content Type

Is

HR

Author

Is

JChang

3. On the Edit Export Query screen:

- Select the Export Revisions with Release Date later than most recent Export Date check box.

- Select the Latest Revisions option.

4. Set export options from the General tab:

- To save space on the local system, select Replace Existing Export Files.

- To include web-viewable files in the archive, select Copy Web Content.

5. Export the archive manually.

6. On the Replication tab, register the archive as an automated exporter.

Set up an automated import on the HR Portal content server:

1. Create a target archive.

2. Select the target archive and ensure that the Update Override Action is set on the General tab.

3. Import the target archive manually.

4. On the Replication tab, register the archive as an automated importer.

Set up an automated pull transfer from the Contribution server to the HR Portal server:

1. On the Contribution content server, create an outgoing provider to the HR portal content server.

2. Open Archiver on the HR portal content server.

3. Open the target collection and make the target archive 'targetable.'

4. Open the source collection and select the source archive.

5. On the Transfer To tab, select the target archive as the target destination.

6. Run a manual transfer.

7. Set the transfer to be automated.

7.9.7.3 Changing Metadata Fields

In this example, you have a custom metadata field, ApprovedBy, which was used in one content server instance, but the field name must be changed to Sponsor for consistency with other content servers.

1. Create the new Sponsor metadata field.

2. Create an archive.

3. Manually export all content to the archive. (You do not need to create an export query.)

4. Set up the following import field map for the archive:

Export Field

Target Field

xApprovedBy

Sponsor

5. From the General tab, select Update as the Override Action.

6. Initiate the import manually.

7. Delete the ApprovedBy field from the content server.

7.9.7.4 Adding Content ID Prefixes

In this example, you have two content servers that are used as contribution servers, but you want to have all content available for consumption from both servers. You can set up an automatic transfer in both directions. However, both content servers use automatic Content ID generation with similar numbering schemes, which could result in errors or overwritten revisions if you import files with Content IDs that already exist on the target content server.

- One way to avoid conflicts is to add a unique prefix in the Auto Number Prefix system property on both content servers.

- Another way to accomplish this is to add a unique prefix during the import process:

To add content ID prefixes:

1. Set up the following value map on the first content server's import archive:

Input Value

Field

Output Value

All check box

Content ID

server2_<$dDocName$>

2. Set up the following value map on the second content server's import archive:

Input Value

Field

Output Value

All check box

Content ID

server1_<$dDocName$>

7.9.7.5 Changing Release Dates

In this example, you are copying archives to other content servers using replication or transfer, but you want the release date on the target content server to be the date the content item was copied.

1. Set up an export and import for replication or transfer.

2. Select the archive to import in the target content server.

3. Set up the following import value map for the archive:

Input Value

Field

Output Value

All check box

Release Date

<$dateCurrent()$>

The release dates will reflect the local date and time of the target content server.

7.9.8 Configuration Migration Tips

There are several points to keep in mind when using the Configuration Migration Utility.

- If you use directory locations on the target system that differ from the standard content server installation directories, you cannot use Configuration Migration but must do a manual copy of the pertinent directories.
For example, if you use partitioned file systems and want to split content server storage on the partitions, you must add configuration variables to the DomainHome/ucm/cs/bin/intradoc.cfg file to point to the correct locations for the directories that are stored elsewhere.

- If you are using different web servers for the source and the target systems, make sure to exclude the web server information when using Configuration Migration to prepare an export.

- Not all components can be exported using the Configuration Migration Utility. For example, components that require an interactive installation cannot be exported. They must be installed separately on the target system.

- Dynamic Converter rules are not transferred with the Configuration Migration Utility. They must be manually added to the target system by copying the data/conversion/cvtemplates.hda file from the source system to the target system. In addition, you should create an archive for dynamic converter templates and transfer them to the target system before transferring other content. Otherwise an error occurs when a document that is eligible for dynamic conversion is imported.

- The Configuration Migration Utility is particularly useful for propagating a part of an instance to another. For example, some customization, such as workflows or content profiles, may best be designed and tested on a development instance. After they are tested they can be migrated to your production system. Other development work, such as component development, is probably best done using the Component Wizard and Component Manager for testing and deployment.

- Problems can occur when importing archives if required fields and validated option lists are not considered. If metadata fields have been changed to be required or if option lists have been altered between one migration and another, it will be difficult to import content into another system with those same metadata field definitions. To avoid this problem, temporarily change required fields to be non-required and change option lists to be non-validated before importing data on a target system.

- You can use the Configuration Migration Utility with the archiver to create a regular 'snapshot' of your instance.You should also make sure to make appropriate backups of your databases at the same time, to ensure that the entire system stays synchronized.

- You should create a configuration migration package before creating an archive package to ensure that the appropriate metadata information is available on the importing content server.

- Remember that migration is an additive process. The exporting configuration bundle of metadata information is added to the metadata that currently exists in the importing content server. If metadata information currently exists that matches the metadata being imported, and if the Force Overwrite rule has been selected during import, then the metadata on the importing content server is overwritten by the metadata from the exported bundle.

7.10 Folder Archiving

This section provides information about folder archiving.

- "Folder Archive Functions"

- "Exporting an Archived Folder Structure"

- "Importing an Archived Folder Structure"

7.10.1 Folder Archive Functions

The Folder Archive is part of the Folders component and has the following functionality:

- Export a folder hierarchy: Used to assign a filename to an exported archive file and save it in a specified location.

- Import folder hierarchy: Used to specify the filename of an archive to import. The imported folder structure removes all current folders and replaces them with the folder hierarchy.

The Virtual Folder Administration Configuration page is used to export and import folder archives.

Figure 7-20 Virtual Folder Administartion Configuration Page

7.10.2 Exporting an Archived Folder Structure

To export a folder hierarchy as an archive, use the following procedure:

1. Log in to the content server as an administrator.

2. Open the Administration tray.

3. Click the Folder Configuration link.

4. Click Export Archive.
A File Download window is displayed.

5. Click Save.
A Save As window is displayed.

6. Navigate to the directory where you want to save the folder archive file.

7. Specify a new file name so that you can easily identify the archive file (for example, 041127_CollectionArchive).

Note:
In Windows, if you leave the file type as Text Document, a .txt extension will be appended to the file name (for example, CollectionArchive.hda.txt). To save the file with just the .hda extension, select the All Files file type.

8. Click Save.
The folder hierarchy is exported to the specified file.

Note:
Depending on the size of the folder hierarchy that is being exported as an archive file, the default heap size value for the JVM may not be adequate. If memory errors are issued during the export procedure, the heap size may need to be increased.

7.10.3 Importing an Archived Folder Structure

Use the following procedure to import an archived folder structure:

Caution:
This procedure removes all current folders and replaces them with the imported folder hierarchy. Typically, you should perform this procedure only on a content server that has no content items in the repository.

1. Log in to the content server as an administrator.

2. Open the Administration tray.

3. Click the Folder Configuration link.

4. Click Browse and navigate to the archive file you want to import.

5. Click Open.
The path and file name appear in the field.

6. Click Import Archive.
A confirmation prompt is displayed.

7. Click OK.
The archived folder is imported and re-created.

See the Oracle Fusion Middleware Application Administrator's Guide for Content Server for details about exporting and importing folders.

7.11 Folder Structure Archiving

The Folder Structure Archive component enables you to archive the folder structure as well as its associated content (if desired). The structure of the folders is archived through database table replication. You can configure which folders (along with all subfolders) should be archived. The folder archives can be accessed by Content Server's Archiver utility for further processing (for example, replication or transfer to a different content server).

The Folder Structure Archive component is installed with Content Server, however, it is disabled by default. To use the component you must enable it with the Component Manager.

This section covers the following topics:

- "Overview of Folder Structure Archive"

- "Differences With Built-in Folders Archiving Features"

- "Working With Folder Structure Archives"

- "Important Implementation Considerations"

7.11.1 Overview of Folder Structure Archive

The Folder Structure Archive component has several uses, including:

- As a backup tool: You can use this component to back up the folder structure (including its content, if desired) and store it in a safe place to be restored in a server malfunction or other calamity.

- As a duplication tool: You can use this component to copy the folder structure (including its content, if desired) and create an exact copy on a different computer to simplify multiserver setups.

- As a synchronization tool: You can use this component to keep the folders environment between two systems synchronized (for example, a development system and a production system, or two identical, redundant systems). Folder archives created using the Folder Structure Archive component can be transferred or replicated to another system.

Important:
Please ensure that you read the "Important Implementation Considerations".

7.11.2 Differences With Built-in Folders Archiving Features

The Folders component has its own built-in archiving features, which are accessed on the Virtual Folder Administration Configuration page.

Functionality Differences

The Folder Structure Archive component can be used alongside these built-in archiving features, but its functionality differs in several important ways:

- The Folder Structure Archive component can export selected portions of the folder structure, whereas the built-in Folders archiving features can only export the entire folder structure.

- The Folder Structure Archive component can create incremental archives-that is, archives that contain only changed folders compared to an earlier version- whereas the built-in Folders archiving features can only create archives that contain all items, even unchanged ones.

- The Folder Structure Archive component can include both the folder structure and folder content in the archives (depending on the value of a Folder Structure Archive Component Variables), whereas the built-in Folders archiving features can only export the folder structure and none of the content in the folders.

- Unlike the built-in Folders archiving features, the Folder Structure Archive component allows the creation of multiple source folder archives, which can all be imported, transferred, or replicated to the same target content server using Content Server's Archiver utility.

Processing Differences

If you export the complete folder structure using the built-in Folders archiving features and you import it into another content server (using the Folders user interface), then that server's existing folder structure is deleted entirely and replaced with the imported structure.

If you create an archive using the Folder Structure Archive component and you import, transfer, or replicate it to another content server (using the Archiver utility), then the existing folder structure is not deleted, and the archived structure is merged into the existing structure.

7.11.3 Working With Folder Structure Archives

This section provides information about working with folder structure archives:

- "Creating a Folder Structure Archive"

- "Updating a Folder Structure Archive"

- "Using a Folder Structure Archive"

- "Configuration Variables"

7.11.3.1 Creating a Folder Structure Archive

To create a new folder structure archive, complete the following steps:

1. Log into the content server as an administrator.

2. Select Administration, then click Folder Archive Configuration.
The Folder Archive Configuration Page is displayed.

3. In the Collection Name list, select the archive collection that the new folder structure archive should be part of.

4. In the Archive Name field, specify the name of the new folder structure archive.

Important:
Ensure that you provide an archive name before selecting folders to be included in the archive. If you select folders first and then specify an archive name, nothing happens when you click Add. (The folder tree collapses completely and your folder selection is lost).

5. In the shaded area, select all folders to include in the folder structure archive.
If you click the check box of a parent folder, all its child folders are selected automatically as well. You can also select and unselect any of the child folders individually. A parent folder will only be selected if all of its subfolders are selected as well. If you unselect any of the child folders, its parent folder is automatically unselected, too. This does not affect the virtual folder path properties of the child folder.

6. Click Add.
A message is displayed saying that the folder archive was added successfully. The archive is now included in the Archive Name list, and also in the list of current archives for the content server instance; see "Using a Folder Structure Archive".

7.11.3.2 Updating a Folder Structure Archive

You can use the definition of an existing folder structure archive, modify it, and create an updated archive. Complete the following steps:

1. Log into the content server as an administrator.

2. Go to the Administration page of the content server, and click Folder Archive Configuration.
The Folder Archive Configuration Page is displayed

3. If required, assign the archive to a different collection in the Collection Name list.

4. In the Archive Name list, select the name of the folder structure archive to update.
The folder archive tree in the shaded area is updated to reflect the current selections for the archive.

Note:
You cannot save the selected archive under a different name. If you change the name in the Archive Name field and click Add, the archive is considered a new archive and you must select the folders again before clicking Add.

5. When defining the folder structure archive on the Folder Archive Configuration Page, you can select a folder without selecting its parent folder.
If you click the check box of a parent folder, all its child folders are selected automatically as well. You can also select and unselect any of the child folders individually. A parent folder will only be selected if all of its subfolders are selected as well. If you unselect any of the child folders, its parent folder is automatically unselected, too. This does not affect the virtual folder path properties of the child folder.

Note:
By default, if a parent folder is not selected, its source collection ID is not passed on to its child folders. If you want the source collection ID of a folder to be retained even if its parent folder is not selected, set the AllowMigrationOfParentFoldersMeta variable to 'true' (this is not the default). See "Folder Structure Archive Component Variables" for details.

6. Click Update.
A message is displayed saying that the folder archive was updated successfully. To process this archive further, see "Using a Folder Structure Archive".

7.11.3.3 Using a Folder Structure Archive

After you create a new folder structure archive, its files are located in the [CS_Instance_Dir]/archives/[Archive_Name] directory, and it is included in the list of current archives for the content server instance in the Archiver utility:

Figure 7-21 Folder structure archive in Archiver utility

The Name column contains the name that was given to the archive when it was created. See "Creating a Folder Structure Archive". The Description column will always say "Archive with folder structures" to indicate the archive's purpose.

The folder structure archive can now be processed further. All normal Archiver functions can be used. For example, the archive can be transferred or replicated to a different content server.

Note:
See "Important Implementation Considerations" for several important considerations that should be taken into account when implementing the Folder Structure Archive component.

7.11.3.4 Configuration Variables

There are several configuration variables that you can use to modify the behavior of folder structure archiving. This section provides information about the types of such variables.

Folder Structure Archive Component Variables

The variables for the Folder Structure Archive component are set in the following file: IdcHomeDir/components/FolderStructureArchive/folderstructurearchive_environment.cfg. This is a read-only file, so if you want to modify a setting, use the Admin Server: General Configuration Page.

The following configuration parameters are supported:

- ArchiveFolderStructureOnly=true|false: If this variable is set to true, the archive will only include the folder structure and none of the content items contained in the structure. This variable enables you to create a copy of the folder structure for backup purposes or identical multiserver setup. The default is false, which means that content items are included in the folder archive.

- AllowArchiveNoneFolderItem=true|false: If this variable is set to true, the archive will include content items, even if they are not in the folder structure. The content that does not belong to any folder is included in the folder structure archive. If it is set to false, only content items that are in the folder structure are exported. You can use this configuration variable to set up replication for folders and content at the same time; otherwise additional replication for folders and normal content would be required. The default is true, which means that content items outside of the folder structure are also included in the folder archive.

- AllowMigrationOfParentFoldersMeta=true|false: If this variable is set to true, the source collection ID of a folder is retained (migrated from the parent folder), even if the parent folder is not selected on the Folder Archive Configuration Page. The default is false, which means that metadata of parent folders is not passed on unless the parent folder is specifically selected.

Important:
After modifying a configuration parameter value, ensure that you restart the content server.

Folders Component Variables

The variables for the Folders component are set in the following file: IdcHomeDir/components/Folders_g/folders_environment.cfg. This is a read-only file, so if you want to modify a setting, use the Admin Server: General Configuration Page.

The following Folders configuration variable is useful with the Folder Structure Archive component:

- CollectionIsConsumptionOnly=true|false: If this variable is set to true, the folders environment on the content server is locked, which means the server is set to receive folder data only (hence consumption). Users with RWD permissions are not allowed to create, move, modify, or delete folders. Users with Admin permissions are not allowed to create folders, but they can move, modify, and delete folders.
This setting should typically be set on a content server that is the target of an archive transfer or replication. It prevents out-of-sync errors between the source server and target server, which could arise if folders were manipulated manually on the target server.

The default setting is false, which means the folders environment on the content server is not locked.

In a replication setup, any deleted folders on the source system are not automatically deleted on the target system. Even with the target system in consumption-only mode, system administrators can manually delete the affected folder on the target system. (Please note that they cannot create folders.)

Caution:
If users are allowed to manipulate folders on the target server, ensure that you select a different initial collection ID (InitialColID setting) for the target server than for the source server during the Folders component installation. Otherwise there may be collection ID collision errors.

Important:
After modifying a configuration parameter value, ensure that you restart the content server.

7.11.4 Important Implementation Considerations

Please note the following important implementation considerations:

- The Folder Structure Archive component cannot be used to replicate Collaboration Manager projects. The folder tree on the Folder Archive Configuration Page will include all collaboration project folders, and you can archive and transfer them to another system. However, a transfer will not carry over all required collaboration project information (access control lists, and so on.) The collaboration projects will not work on the target system.

- The Folder Structure Archive component cannot be used to replicate Site Studio Web sites. The folder tree on the Folder Archive Configuration Page will include all Site Studio website folders, and you can archive and replicate them to another system. However, the replicated website may not work correctly on the target system. If you want to replicate a Site Studio website, use Site Studio's built-in replication features.

- If you are using the Folder Structure Archive component as a duplication or synchronization tool between two systems, it is recommended that you select different initial collection IDs (InitialColID setting) for the source and target system when installing the Folders component. If the initial collection IDs are the same and users are allowed to manipulate folders on the target system, there may be collection ID collision errors during the duplication or synchronization process.

- You can select a folder in the tree on the Folder Archive Configuration Page without selecting its parent folder. This does not affect the folder's virtual folder path-in other words, the virtual path will remain to be [Parent_Folder]/[Folder], even if [Parent_Folder] is not selected. If you transfer or replicate the archive to another content server and the parent folder does not exist on that server, it is automatically created, but without the metadata of the corresponding folder on the source server.

- If you want to transfer or replicate a folder structure archive between two content servers, it is recommended that you do not manually create the folder structure on the target system. Folders that do not exist on the target system are created automatically during the transfer or replication process. If you do create folders manually, this may lead to out-of-sync errors during the process since the folder names may match, but their underlying unique identifiers (xCollectionID) do not. To help reduce mismatching folder issues, you can use the CollectionIsConsumptionOnly configuration variable to lock the folders environment on the target system.

- If you set up replication between two systems using the Folders Archive Structure component, folders that are created or moved on the source system are automatically created or moved on the target system as soon as content is added to the source folder. Also, if you change the metadata of a folder on the source system, these changes are automatically reflected on the target system as well (as soon as content is added to the target folder). Any folders that are deleted on the source system are automatically deleted on the target system. When a folder is deleted, all its information is gone.
Similarly, if a folder move causes the folder to no longer reside in an archived folder, this folder will not be archived and replicated. Consider a system with folders /FolderA, /FolderA/SubfolderA, /FolderB, and /FolderB/SubfolderB. If /FolderA is set up to be archived and /FolderB is not, moving SubfolderA to /FolderB means it will not be replicated. However, if both /FolderA and /FolderB are archived, the move of SubfolderA would be replicated.

- If you set up archiving or replication of folders and content items using the Folders Archive Structure component, the shortcuts of the folders and content items are not archived or replicated.

7.12 Archiver Replication Exceptions

The ArchiverReplicationExceptions component can be used to prevent failed imports from stopping replication. This component is installed and enabled by default with Content Server.

This section covers the following topics:

- "Overview of ArchiverReplicationExceptions"

- "Administering and Using ArchiverReplicationExceptions"

7.12.1 Overview of ArchiverReplicationExceptions

The ArchiverReplicationExceptions component enables administrators to prevent failed imports from stopping replication. It does this by capturing such failed imports and putting them into an exceptions archive and sending email to the administrator that such a failed import has occurred.

- "How ArchiverReplicationExceptions Works"

- "Scenario 1"

- "Scenario 2"

7.12.1.1 How ArchiverReplicationExceptions Works

Several configuration entries must be manually added to the IntradocDir/config/config.cfg file to support ArchiverReplicationExeceptions. The configuration entries define a variety of conditions to determine the level of error reporting, to direct failed imports to an exceptions directory, and to ignore and handle multiple failed imports when a systemic error is detected. Parameters for both automatic and manual imports are provided.

7.12.1.2 Scenario 1

In this scenario an import of a document has failed because the content type "DOC" does not exist in the importing server. The error reporting level (ArchiverEmailErrorLevel) was set to collision, standard, severe, and the ArchiverErrorNotifyUser was set to sysadmin. The following is an example of an archiver import failure email notification:

Archiver Import Failure
There was a serious error during the import of a document which may prevent that document from being properly synchronized in state with the exporting content server. Content item 'test1' was not successfully checked in. The content type 'DOC' is not defined in the system.
Revision Being Imported
Collection:  idc
Archive Name:  ar1
Source Instance:  idc
Batch Name:  07-sep-24_15.15.41_766/07267151541~1.hda
Content ID:  test1
Title:  test1
Author:  sysadmin
Revision:  1
Release Date:  9/24/07 3:13 PM
Create Date:  9/24/07 3:14 PM

The Document Has Been Copied To An Exceptions Archive

Collection:  idc
Archive Name:  ImportExceptions
Batch Name:  07-sep-24_15.15.41_766/07267151541~1.hda
Total Captured In Archive:  1

7.12.1.3 Scenario 2

An import is being attempted but continually fails. The sysadmin is aware that there may be problems during the import, but does not want an email notification of every failure. By setting the ArchiverMaxConsecutiveImportErrors (default is 10), the sysadmin can set several failures that can occur before the cessation of email notification. Emails are sent until this number of errors is reached. If any import from the exporter should succeed before the set number is reached, or if the Content Server is restarted, the counter is reset to 0. Note that when the maximum number of errors is reached the automated import of the archive is aborted.

7.12.2 Administering and Using ArchiverReplicationExceptions

The primary purpose for this component is to allow filtering of failed imports to optimize the handling and notification of such failures. For content items to be processed by ArchiverReplicationExceptions, the administrator must manually set configuration entries in the IntradocDir/config/config.cfg file. The configuration variables customize the behavior of the importing content server to allow for certain situations and to distribute the error reporting based on the configured criteria.

The following configuration variables can be used to customize behavior. These values should be set in the IntradocDir/config/config.cfg file under #Additional Variables.

By prepending any of the configuration entries with the name of an archive, with a colon (:) as a separator, that configuration entry will only apply to that archive. For example, to enable capturing exceptions for the archive MyRemoteImportArchive, use the following entry in the config.cfg file:

MyRemoteImportArchive:IsArchiverCapturingExceptions=true

If an archive name prefix is not applied, then the value set is the global default for all archives.

- IsArchiverCapturingExceptions: The primary functionality of this component is not enabled unless this configuration entry is turned on.
Default is false.

- ArchiverImportExceptionsArchiveName: The name of the archive to hold failed imports. The archive will be created in the same archive collection as the archive that contained the document that failed an import.
The default is ImportExceptions.

- ArchiverMaxConsecutiveImportErrors: The maximum number of consecutive import errors before the import of the archive is aborted.
The default is 10.

- ArchiverErrorNotifyUser: The user to notify when there is an import failure. The default is sysadmin. The email is generated only if the import error is at a level that is configured to generate emails.
The entry can be a comma separated list of user names, but all the user names have to be defined in the content server and have associated email addresses.

- ArchiverEmailErrorLevels: The error levels at which an import error should generate email during automated import. The possible levels are as follows:

- collision: The import failed because an existing revision of a document blocked it. Usually this is caused by the importing revision having a release date (or create date depending on configuration) that is earlier than the date of the latest revision of an existing document.

- standard: The import failed because of a normal error. A typical such error would be a metadata field that has an invalid value.

- severe: The import failed because of a severe unexpected error in the content server. A typical reason for this might be a network failure to either the file system or database.

The configuration entry is set to a comma separated list of any of the above values. If an automated import error occurs, it is classified in one of the above levels and if the level is in the list configured for this parameter then an email is generated for that error.

The default is collision,standard,severe (or all).

- ArchiverManualImportEmailErrorLevels: This is similar to ArchiverEmailErrorLevels except it applies to manual archive imports. A manual import is one directly driven by an end user or administrator and is not part of an import done by a "registered automated importer".
The default is empty (or none).

- ArchiverCaptureExceptionErrorLevels: A list of error levels for which an import error should capture a copy of the document and put it into the exceptions archive (see ArchiverImportExceptionsArchiveName). If the document is captured then the error will not stop an automated import. The automated import will delete the document from the archive when the batch file containing the document has been fully imported. See ArchiverEmailErrorLevels for a list of error levels and how to configure the entry.
The default value is collision,standard.

- ArchiverManualImportCaptureExceptionErrorLevels: This is similar to the ArchiverCaptureExceptionErrorLevels parameter except it applies to manual archive imports (see ArchiverManualImportEmailErrorLevels for more on manual imports). If an import error is captured it is copied into the exceptions archive but it does not delete it from the originating archive. If the error is captured it will not count against the maximum number of errors allowed during a manual import (see the standard content server configuration entry MaxArchiveErrorsAllowed which defaults to 50).
The default is empty (or none).

- ArchiveExceptionsMaxNumberDocuments: The maximum number of documents that can be stored in the exceptions archive.
When this number is reached, then import failure will again prevent continued automated import. However, an email is sent to ArchiverErrorNotifyUser indicating that the import failed and that the exceptions archive is full. Unlike the other configuration entries, if you use an archive prefix (separated by a colon) to limit the configuration entry to a particular archive, the archive name must be the name of the exceptions archive not the archive with the originating documents being imported.

The default is 50.

The parameter ArchiverMaxConsecutiveImportErrors addresses the issue of skipping over errors and sending email notifications on the errors when the error is caused by a systemic problem (such as all documents having the same wrong metadata field on export). This results in numerous documents being unnecessarily captured and generating the attendant volume of unwanted email. This configuration entry helps detect such scenarios. During an automated import, if too many consecutive import errors are detected, then the current archive import is aborted. Manual imports follow the standard rules for maximum errors (see MaxarchiveErrorsAllowed).If any import (from any archive) is successful, then the consecutive import failure count is reset to 0.

If the same document fails an import (twice or more) sequentially an email is sent out only for the first failure. If the same document fails an import but is from a different batch load file, the email for it is not suppressed if an email for that document has already been sent for a previous error.

7.13 Troubleshooting Archiving Issues

This section provides solutions to several common archiving issues.

- "Importing Issues"

- "Exporting Issues"

- "Transfer Issues"

- "WebDAV Issues"

- "Replication Issues"

- "Oracle-Specific Issues"

- "Miscellaneous Issues"

7.13.1 Importing Issues

This section covers the following topics:

- "File Extension Errors on Import Machine"

- "Selecting Specific Batch Files for Import"

- "Import Maps Do Not Work After Archive Import"

- "Identifying Imported Content Items From Archive"

- "Duplicate Content Items in Content Servers"

- "Importing Archived Content to Proxied Server Fails"

- "No Importing Errors But Documents Are Missing"

- "Errors About Invalid Choice List Values"

- "Import Fails Due to Missing Required Field"

- "Changed Metadata Field Makes the Archiver Freeze During an Import"

7.13.1.1 File Extension Errors on Import Machine

Symptom

I am receiving errors on the importing machine indicating that there are transfer and file extension problems with the documents.

Problem

The following errors were issued to the Archiver log:

Error: Event generated by user <user_name> at host <host_name>. File I/O error. Saving to file collection.hda. Write error.
Error: Import error for archive <archive_name> in collection <collection_name>: Content item <item_name> was not successfully checked in. The primary and alternate files must have different extensions.

Recommendation

The I/O error on the export side probably corrupted the batch file and is, in turn, causing the file extension error on the import side. Possible solutions include:

- Open the batch file in a text editor and check for invalid data. Try deleting the exported collection.hda file and manually re-run the export/import function.

- On the exporting server, open the applicable collection.hda file and look for the lines associated with the content items that caused the file extension error. Some of the revisions of these content items may have the native file in the vault location listed in the alternate file location. There might also be a format entry for the alternate file. Delete these lines and re-import the files.

- Add an alternate extensions configuration setting to the Content Server's configuration config.cfg file (IntradocDir/config/config.cfg) on the importing server:

1. Open the config.cfg file in a text editor:
IntradocDir/config/config.cfg

2. Locate the General Option Variables section

3. Enter the following configuration setting:

AllowSamePrimaryAlternateExtensions=true

This configuration setting allows checked in content items to use identical document extensions for both the alternate and primary files.

4. Save and close the config.cfg file.

Note:
Although it probably is not necessary to add this configuration setting to the content server config.cfg file on the exporting server, it may be worthwhile to do so for general preventative measures.

5. Restart the Content Server.

7.13.1.2 Selecting Specific Batch Files for Import

Question

How can I select and re-run specific batch files from the General tab of the Archiver utility without deleting the remaining files that are required for backup purposes?

Recommendation

The most efficient method would be to create a new collection, copy the desired archives to the new collection, and run the import from there.

7.13.1.3 Import Maps Do Not Work After Archive Import

Symptom

I configured a value map to change metadata values during the import on an archive collection. But after the transfer, the import maps do not work.

Problem

The metadata values didn't reflect the configured metadata value changes.

Recommendation

To ensure that metadata value changes are retained when the files are exported into an archive and then later imported from that archive, the value maps must be configured on both sides of the transfer process. This means that the same value map must be configured on both the source (exporting) server as well as the target (importing) server.

7.13.1.4 Identifying Imported Content Items From Archive

Question

Due to a system crash, I need to import content from the old archive into a new archive without changing the content information (metadata) of the documents. How can I preface each content item using a letter or number to indicate that all the documents with this designation are new imports (but actually originated from the old archive)?

Recommendation

The archived documents can be re-imported and appropriately marked to distinguish them from other imported content items by applying an import map using the Content ID metadata field. An import map allows you to configure how values are copied from one metadata field to another during import. To set up the import mapm, complete the following steps:

1. On the Import Maps tab of the Archiver utility, click Edit in the Field Maps section.
The Edit Value Maps screen is displayed.

2. Select the All check box (leave the Input Value field blank).

3. Select Content ID from the Field list.

4. Enter X<$dDocName$> in the Output Value field.
Where 'X' is the letter or number used to distinguish the re-imported content items and 'dDocName' is the database table field value for the document Content ID.

5. Click OK.

After you re-import the archive, the letter or number used for 'X' should be added to the content ID of each content item. Be sure to configure the same value map on both the source (exporting) server and the target (importing) server. This ensures that the metadata value changes are retained when the files are imported from the archive.

7.13.1.5 Duplicate Content Items in Content Servers

Symptom

When I try to check in or import a content item, the following error message is issued:

Content item already exists.

Recommendation

This error is issued when archiving is done between contribution servers that are using the same autonumbering scheme for content IDs. For example:

- 'Content ID 003' is checked into content server A and later archived to content server B. If a file is checked into content server B and the next autogenerated number happens to be 003, the error occurs.

- 'Content ID 005' is checked into both content server A and content server B. If this same content item is archived from content server A to content server B, the error occurs.

Possible solutions include:

- Set up an import value map that will add a prefix to the content ID of the imported files. For details refer to "Identifying Imported Content Items From Archive".

- In each content server, use the System Properties utility to set up an automatic numbering prefix for checked-in content items:

1. Start the System Properties utility.

2. Open the Options tab.

3. Select the Automatically assign a Content ID on check in check box.

4. Enter the desired prefix in the Auto Name Prefix field.

5. Click OK.

6. Restart the Content Server.

7.13.1.6 Importing Archived Content to Proxied Server Fails

Symptom

I am trying to import content from an exported archive to my proxied Content Server, but the import fails.

Recommendation

For more information about Archiver problems, open and view the Archiver logs (accessible from the content server's Administration page). These logs provide the type of message along with more descriptive information about the logged messages.

For example, if the Archiver log indicates that an import problem involves a metadata field option value that is unavailable, information about configured option lists for metadata fields can be found on the Information Fields tab of the Configuration Manager utility (accessible from the Administration page).

Using this information, compare the option list for the problem metadata field on both the exporting and importing servers. If there are any differences, corrections in one of the servers will make both option lists identical. This would resolve the unavailable option discrepancy.

7.13.1.7 No Importing Errors But Documents Are Missing

Symptom

When I run the import function, no errors are issued, but not all of the documents are being imported.

Problem

I exported 428 documents from the development server along with the configuration information (the metadata fields). Then, I transferred the archive to the main production server and ran the import. No errors were issued, so I thought everything had gone well. Unfortunately, when I searched the documents, I discovered that only 198 of the original 428 were actually imported.

Recommendation

Suggestions to resolve this problem include:

- Make sure that all Microsoft Word documents are included in the search index.
Particular versions of the search component do not include Microsoft Word documents with embedded links in the search index. Thus, these files will not be found in search queries.

You can remove all embedded links from the affected documents or add the following configuration setting to IntradocDir/config/config.cfg:

CheckMkvdkDocCount=true

This configuration setting ensures that all Word files are included in the search index. However, only the metadata is included, not the full text.

- Try exporting the original set of documents and ensure that the source files are deleted. Then re-import the archive that was just exported.

7.13.1.8 Errors About Invalid Choice List Values

Symptom

My imports are failing.

Problem

The system issues error messages indicating that there are invalid choice list values. I am currently using an option list in the Dependent Choice List applet to configure and control the values.

Recommendation

Apparently a specific metadata taxonomy has been established for your option lists such that there are probably fields that are dependent on each other. In this case, certain values in option lists are available based on what values have been selected in a previous option list. Unfortunately, when using the Archiver, the dependencies in your option lists are obviously conflicting with the content server's capacity to work with custom metadata fields.

A workaround for the conflict involves using the content server's Configuration Manager utility rather than the Dependent Choice List applet. This necessitates that you enter the metadata fields and corresponding option list values on the Information Fields tab of Configuration Manager:

1. Log into the Content Server as an administrator.

2. Go to the Administration page and click the Configuration Manager link.
The Configuration Manager utility is started.

3. Open the Information Fields tab.

4. Click the Add button and enter one of your metadata field names in the Add Custom Info Field dialog.

5. Click OK.
The Add Custom Info Field window is displayed.

6. Complete the fields as appropriate.

7. In the Option List Type field, choose the Select List Not Validated option.

8. This option ensures that content whose specified value does not match one currently entered in the Use Option List are nevertheless checked in with the specified value. The Use Option List field lists the name for the list of values a user may choose from for the specified field.

9. Click OK.

10. Click the Update Database Design button.

11. Click the Rebuild Search Index button.

Use this method for the duration of your import process.

7.13.1.9 Import Fails Due to Missing Required Field

Symptom

I used the Archiver to export documents. Now, I'm trying to import them and the process fails.

Problem

When I try to import the previously exported documents, the Content Server issues an error indicating that the 'Company' metadata file is required.

Recommendation

You will need to use the content server's Configuration Manager utility to edit the 'Company' field and make it a non-required field:

1. Log into the Content Server as an administrator.

2. Go to the Administration page and click the Configuration Manager link.
The Configuration Manager utility is started.

3. Open the Information Fields tab.

4. Select the Company metadata field from the Field Info list.

5. Click Edit.
The Edit Custom Info Field window is displayed.

6. Deselect the Require Value check box.

7. Click OK.

8. Click the Update Database Design button.

9. Click the Rebuild Search Index button.

You should now be able to successfully re-import the archive.

7.13.1.10 Changed Metadata Field Makes the Archiver Freeze During an Import

Symptom

Some of our product names have changed and we need to update one of the metadata fields in the affected documents. After exporting all the documents with the old product name metadata field, I then attempt to import the documents using the new product name metadata field. But, every time I try this, the Archiver processes only a portion of the total archiving task and then stops.

Problem

Once the Archiver freezes, I am unable to navigate the Content Server user interface and I must shut down all of the open browsers. Also, during the next five minutes after shutting down the browsers, I have no connectivity to the Content Server at all. After this five-minute interval, I can access the Content Server again.

In addition to this freezing problem, the following error message is issued:

Stream error (299) - SKIPPING

Recommendation

One or more processes seem to be interrupting the import. Some possible problem solutions could be any of the following:

- Checking the Metadata Field Properties

- Checking the Indexing Automatic Update Cycle

7.13.1.10.1 Checking the Metadata Field Properties

The product name metadata field may not have been properly updated in Configuration Manager. Depending on the type of metadata field that the 'product name' is, changing the value could be the reason for the lock-up problem. Is the product name metadata field a (long) text field only or also an option list? If it is an option list, make sure that the new name value is a selection on the corresponding list.

1. Log into the Content Server as an administrator.

2. Go to the Administration page and click the Configuration Manager link.
The Configuration Manager utility is started.

3. Open the Information Fields tab.

4. Select the product name metadata field from the Field Info list.

5. Click Edit.

6. The Edit Custom Info Field window is displayed.

7. If the Field Type value is Text or Long Text AND the Enable Option List check box is disabled, click OK or Cancel (this should not cause the lock-up problem).
Otherwise,

If the Enable Option List check box is selected, then make sure that the new product name metadata field value is included as a selection on the corresponding list:

1. Locate the Use Option List field and click Edit.

2. Enter the new product name metadata field value in the Option List dialog.

3. Click OK.

8. Click OK again (on the Edit Custom Info Field window).

9. Click the Update Database Design button.

10. Click the Rebuild Search Index button.

7.13.1.10.2 Checking the Indexing Automatic Update Cycle

The lock-up problem may be due to the indexer's automatic update cycle. The error message indicates that the indexer is failing because it loses connectivity. Every five minutes, the indexer executes an automatic update cycle and could somehow be grabbing the index file and locking it. If so, it might be useful to disable the indexer's automatic update cycle while you run the import.

1. Log into the Content Server as an administrator.

2. Go to the Administration page and click the Repository Manager link.
The Repository Manager utility is started.

3. Open the Indexer tab.

4. Click the Configure button in the Automatic Update Cycle section.
The Automatic Update Cycle dialog displays.

5. Deselect the Indexer Auto Updates check box.

6. Click OK.

Note:
Be sure to reactivate the automatic update cycle after completing the import. Otherwise, the server will no longer automatically update the index database, which could adversely impact future search results.

7.13.2 Exporting Issues

This section covers the following topics:

- "Total Export Possible with Blank Export Query"

- "New Check-Ins and Batch File Transfers"

- "Exporting User Attributes"

- "Folder Archive Export Doesn't Work If Collections Table Has Many Records"

7.13.2.1 Total Export Possible with Blank Export Query

Question

If I do not create an export query to define the content items to export, will the entire contents of my Content Server be exported?

Recommendation

Yes, test exports have confirmed that leaving the Export Query section blank (not defining an export query) will ensure that the Content Server contents are completely exported.

7.13.2.2 New Check-Ins and Batch File Transfers

Question

If I check some documents into the Content Server after I have initiated a large export (but before it completes), will these documents be included in the export? Or, does the Archiver read the timestamp information and determine that the new files are more recent than those originally allocated for the export and not include them? Also, what happens to the archive export if the connection between the servers is interrupted or lost during the export?

Recommendation

When the export is initiated, Archiver runs a query on the system to build a list of the documents that are to be exported. This information is cached and used to build the export archive. Therefore, any new documents that are checked in during the export process will not be included even if they match the export query definition.

If the connection between servers is disrupted, the export process on the source server continues but the transfer to the target server stops. The source server accumulates a number of batch files. While waiting to transfer these files, the source server continues to ping the target server for a connection at regular interval. When the connection is reestablished, the accumulated batch files are transferred to the target server.

If you have used an automated (replicated) transfer, the batch files and their associated content files are removed from the source Content Server. If you have used a manual transfer, the batch files and their associated content files remain in the source Content Server.

7.13.2.3 Exporting User Attributes

Question

How can I export users in an archive?

Recommendation

You can export a users.hda file, which contains the user attributes from the Users database table, as follows:

1. Log into the content server as an administrator.

2. Go to the Administration page and click the Archiver link.
The Archiver utility is started.

3. Open the Export Data tab.

4. Click Edit in the Additional Data section.
The Edit Additional Data dialog is displayed.

5. Select the Export User Configuration Information check box.

6. Click OK.

7.13.2.4 Folder Archive Export Doesn't Work If Collections Table Has Many Records

Symptom

I use the folder archive export feature to move my website hierarchy created by Site Studio. Initially, I can export folders by using the Virtual Folder Administration Configuration page without any problem. However, as my Web site grows, this function does not work anymore. The following errors are issued during the export procedure:

Error <timestamp> Event generated by user '<user>' at host '<host_name>'. Referred to by http://<host>/intradoc-cgi/nph-idc_cgi.exe?IdcService= COLLECTION_GET_ADMIN_CONFIG. Unable to retrieve content. Unable to execute service method 'loadCollectionArchive'. (System Error: Unknown error.)
Error <timestamp> IdcAdmin: Event generated by user '<user>' at host '<host>'. Unable to obtain the console output. Unable to execute the service 'GET_SERVER_OUTPUT' on Content Server 'contribution'. Unable to receive request. Response from host has been interrupted. Read timed out.

There is also an out-of-memory error in the Content Server output console:

<timestamp> SystemDatabase#Thread-13: SELECT * FROM Collections, ColMeta WHERE Collections.dCollectionID=ColMeta.dCollectionID AND dParentCollectionID=564
java.lang.OutOfMemoryError
Reporting error on thread Thread-13 occurring at <timestamp>.
java.lang.OutOfMemoryError
java.lang.OutOfMemoryError

Problem

Depending on the size of the folder hierarchy that is being exported as an archive file, the default heap size value for the Java Virtual Machine (JVM) may not be adequate.

Recommendation

In the Content Server's DomainHome/ucm/cs/bin/intradoc.cfg file, comment out the JvmCommandLine setting and increase heap size to 512 M:

#JvmCommandLine=/home/contribution/shared/os/<os>/j2sdk1.4.1/bin/java -cp $CLASSPATH $STARTUPCLASS
JAVA_OPTIONS= -Xmx512m

After restarting Content Server, the archive export function should work correctly again.

7.13.3 Transfer Issues

This section covers the following topics:

- "Transfer Stopped When Target Locked Up"

- "Aborting/Deleting a Running Transfer"

- "Verifying the Integrity of Transferred Files"

- "Transfer Process Is Not Working"

7.13.3.1 Transfer Stopped When Target Locked Up

Symptom

The automated transfer function stopped when the target server locked up.

Problem

After restarting the target server, the log file listed an error message stating that there was a problem with a security group and that this prevented the import on the target server.

Recommendation

In this case, obviously the security group problem on the target server must be corrected before the transfer can proceed. Two additional procedures to perform that can help include:

- Verifying and Testing the Outgoing Provider

- Restarting the Content Server

7.13.3.1.1 Verifying and Testing the Outgoing Provider

Verifying and testing the outgoing provider ensures that it is set up and working properly:

1. Log into the source content server as an administrator.

2. Go to the Administration page and click the Providers link.
The Providers page is displayed.

3. Click the Info link of the appropriate outgoing provider.
The Outgoing Provider Information page is displayed.

4. Verify the information.

5. Return to the Providers page and click the Test link corresponding to the outgoing provider.

7.13.3.1.2 Restarting the Content Server

In some cases, after problems have been corrected on either the source or the target server, the source server may stop transferring or possibly the automation function no longer works. In either case, restarting Content Server should resolve the problem.

7.13.3.2 Aborting/Deleting a Running Transfer

Question

I accidentally started transferring an excessively large file to the production content server. What is the most efficient way to stop the transfer process while it is running?

Recommendation

There are several methods to abort or delete a transfer, including:

- Disabling the Outgoing Provider

- Deleting a Transfer from the Transfer To Tab

- Deleting an Automated Transfer

7.13.3.2.1 Disabling the Outgoing Provider

The fastest method to abort a running transfer is to disable the source server's outgoing provider:

1. Log into the source content server as an administrator.

2. Go to the Administration page and click the Providers link.
The Providers page is displayed.

3. Click the Info link of the appropriate outgoing provider.
The Outgoing Provider Information page is displayed.

4. Click the Disable button.

7.13.3.2.2 Deleting a Transfer from the Transfer To Tab

To delete a transfer from the Transfer To tab, complete the following steps:

1. Log into the source content server as an administrator.

2. Go to the Administration page and click the Archiver link.
The Archiver utility is started.

3. Select Options and then Open Archive Collection.

4. Select the applicable collection from the list.

5. Click Open.

6. On the Archiver window, select the source archive in the Current Archives list.

7. Open the Transfer To tab.

8. Click Remove in the Transfer Destination section.

9. You are prompted to confirm the action.

10. Click Yes.

7.13.3.2.3 Deleting an Automated Transfer

To delete an automated transfer from the Automation for Instance screen, complete the following steps:

1. Log into the source content server as an administrator.

2. Go to the Administration page and click the Archiver link.
The Archiver utility is started.

3. Select Options and then View Automation For Instance.
The Automation For Instance window is displayed.

4. Open the Transfers tab.

5. Select the automated transfer to delete.

6. Click Remove.
The automated transfer is removed from the list.

7.13.3.3 Verifying the Integrity of Transferred Files

Question

What is the best approach to verify the integrity of the files that have been transferred between two servers? Obviously, the documents in the target content server instance should be identical to those in the source instance. I need to ensure that all documents were in fact transferred and if some were not transferred, I must determine which ones failed to transfer.

Recommendation

To ensure that the transferred documents are identical to those on the source server, two items can easily be checked.

- The Revisions table:
Specifically, match the contents of the dDocName and dRevLabel columns on both instances and verify the accuracy or discrepancies between them.

- The file system:
Check the native file repository:

(DomainHome/ucm/cs/vault/content_type)

and Web-viewable file repository:

(DomainHome/ucm/cs/weblayout/groups/public/documents/content_type)

on each server and verify the accuracy or discrepancies between them.

7.13.3.4 Transfer Process Is Not Working

Symptom

The transfer process is not setting up properly.

Recommendation

If the transfer process is not functioning correctly, check the outgoing provider on the source server and ensure that the information is correct. In particular, make sure that the server host name is correct and matches the HTTP server address.

To verify the server host name on the source server, complete the following steps:

1. Start the System Properties utility.

2. Open the Internet tab.

3. Note the HTTP server address setting.

4. Go to the Administration page and click the Providers link.
The Providers page is displayed.

5. Click the Info link of the appropriate outgoing provider.
The Outgoing Provider Information page is displayed.

6. Check the server host name and make sure it corresponds exactly to the HTTP server address setting in System Properties.

7. If the server host name setting is different than the HTTP server address, click the Edit button.

8. Modify the Server Host Name setting as necessary.

9. Click Update.

10. Restart the content server.

7.13.4 WebDAV Issues

This section covers the following topics:

- "Archiver Error With WebDAV and Content Server"

7.13.4.1 Archiver Error With WebDAV and Content Server

Symptom

I am using both WebDav and the content server to check in documents. I would like to be able to view all of the checked-in documents through the WebDAV interface but I can see only the documents that were physically checked in through WebDAV. Currently, I am using the Archiver utility to import the files and have configured a value map using the xCollectionID field. This field is currently set to zero or null and I'm trying to update the value to 182.

Problem

For each file that I try to import, the following error is logged in the Archiver log:

Unable to load collection mappings, too many items.

Recommendation

The error message indicates that you are exceeding the maximum number of items per folder. There is a configurable limit to how many items a folder can hold. To check and update your current limit settings, complete the following steps:

1. Log into the source content server as an administrator.

2. Go to the Administration page and click the Folder Configuration link.
The Virtual Folder Administration Configuration page is displayed.

3. Check the following two limit settings:

- Maximum Folders Per Virtual Folder

- Maximum Content Per Virtual Folder

4. Increase both of these limit settings to accommodate your import requirements.
or,

Implement an 'infinite' limit setting by removing the limit setting.

5. Click Update.

6. Restart the content server.

Note:
You should be aware, however, that the system performance will decrease with the increased number of items that you have in a folder.

7.13.5 Replication Issues

This section covers the following topics:

- "Stopping the Automatic Import Function"

7.13.5.1 Stopping the Automatic Import Function

Question

How can I stop the automatic import function?

Recommendation

When content meets the specified criteria, the automatic importer is, by default, configured to automatically perform an import every five minutes. However, there are two ways to disable the automatic import function:

- Unregistering an Importer from the Replication Tab

- Deleting a Registered Importer from the Automation for Instance Screen

7.13.5.1.1 Unregistering an Importer from the Replication Tab

To unregister an importer from the Replication tab, complete the following steps:

1. Log into the source content server as an administrator.

2. Go to the Administration page and click the Archiver link.
The Archiver utility is started.

3. Select the archive in the Current Archives list.

4. Open the Replication tab.

5. Click Unregister.
The automatic import function is disabled from the selected archive.

7.13.5.1.2 Deleting a Registered Importer from the Automation for Instance Screen

To delete a registered importer from the Automation for the Instance screen, complete the following steps:

1. Log into the source content server as an administrator.

2. Go to the Administration page and click the Archiver link.
The Archiver utility is started.

3. Select Options and then View Automation For Instance.
The Automation For Instance screen is displayed.

4. Open the Importers tab.

5. Select the registered importer to delete.

6. Click Remove.
The registered importer is removed from the list.

7.13.6 Oracle-Specific Issues

This section covers the following topics:

- "Allotted Tablespace Exceeded"

7.13.6.1 Allotted Tablespace Exceeded

Symptom

I cannot transfer files. Every time I try to transfer files, I get 'max extents' error messages.

Problem

The following error messages (or similar) are issued:

IdcApp: Unable to execute query '<query_name>'. Error: ORA-01631: max # extents (50) reached in table <table_name>.
ORA-01631 max # extents (<text_string>) reached in table <table_name>.

Recommendation

When the content server creates its database tablespace, it only allocates 50 extents. As the database grows and is re-indexed, it uses more space (extents). Eventually, the 50 extents limit is exceeded. At some point in the transfer, one of your files tried to extend past the 'max extents' limit. In this case, try implementing one or more of the following solutions:

- Look for weblayout queries that are excessively large, eliminate them, and retry your transfer.

- Perhaps a Content Server user does not have the right permission grants (resource and connect) to the content server schema. That user must have the temporary tablespace and default tablespace set to the content server defaults.

- If the system 'max extents' limit is less than the system maximum, you must increase the number of extents that are available. Refer to your Oracle documentation or ask your database administrator for the appropriate Oracle SQL command to increase the tablespace extents.

- You can optionally choose to re-create the database using larger initial, next or percent to grow parameters for the tablespaces. In this case, it is advisable to set the initial extents and next extents to 1Mb. Set the percent to grow parameter (PCTINCREASE) to 0% to allow the tables to automatically grow on an as-needed basis.

7.13.7 Miscellaneous Issues

This section covers the following topics:

- "Archiving Does Not Work With Shared File System"

- "Archiving Does Not Work Over Outgoing Provider"

7.13.7.1 Archiving Does Not Work With Shared File System

Symptom

I am trying to transfer between two content servers with access to a shared file system but it is not working.

Recommendation

When transferring between content servers on a shared file system, the mapped or mounted drive must be available to both content servers. This means that the computers must be on and logged in as a user who has system access to both content servers. Make sure that all of the following conditions are met:

- Both computers are turned on.

- Both computers are logged in as a user with system access to both content server file systems.

- The shared drive has been properly mapped or mounted so the content server can "see" it. Having network access to the computer is not sufficient.

7.13.7.2 Archiving Does Not Work Over Outgoing Provider

Symptom

I am trying to transfer between two content servers over an outgoing provider but it is not working.

Recommendation

The content server that has an outgoing provider set up is considered the 'local' server, and the target content server for the outgoing provider is considered to 'proxied' server. Files are always transferred in the direction of the outgoing provider, from the local (source) instance to the proxied (target) instance.

It is possible that when the outgoing provider was added and defined for the source content server, the Proxied check box was selected. However, because the relative web root is the same for both content servers, the outgoing provider is confused. The Proxied check box should be selected only if the target content server was installed as an actual proxy of the local (master) content server. This server option should not be selected if the relative web root is the same for both content server.

A User Interface

This appendix contains the following topics about the Content Server administration interface:

System Properties and Settings Interface

- "Admin Server Interface"

- "System Properties Configuration Interface"

- "Indexing and Search Content Interface"

- "Web Server Interface Screens"

- "Provider Interface"

- "File Store Administration Interface"

- "Scheduled Jobs Administration Interface"

- "Batch Interface Screens"

- "Content Server Analyzer Interface"

- "Error and Status Information Interface"

Security and User Access Interface

- "Security Administration Interface"

- "Groups, Roles, and Permissions Interface"

- "Accounts Interface"

- "User Login and Alias Interface"

- "Proxy Connections Interface"

Components Interface

- "Components Interface"

- "Component List Screen"

- "Component Wizard Main Screen"

- "Component Creation Screens"

- "Build Screens"

- "Advanced Component Manager Page"

- "Component Manager Page"

System Migration Interface

- "Configuration Migration Interface Screens"

- "Archive, Collection, and Batch Interface"

- "Export Interface Screens"

- "Import Interface Screens"

- "Transfer Interface Screens"

- "Replication Interface Screens"

- "Folder Archive Configuration Page"

A.1 System Properties and Settings Interface

The following screens are used to configure Content Server system properties and settings:

- "Admin Server Interface"

- "System Properties Configuration Interface"

- "Indexing and Search Content Interface"

- "File Store Administration Interface"

- "Web Server Interface Screens"

- "Provider Interface"

- "Batch Interface Screens"

- "Content Server Analyzer Interface"

- "Error and Status Information Interface"

A.1.1 Admin Server Interface

The following screens are available when using the Admin Server.

- Admin Server Page

- Admin Server Status Page

- Admin Server Output Page

- Administration Page

A.1.1.1 Admin Server Page

The Admin Server page is used to view server status, manage components, and to access Content Server system properties, log, and audit information.

To access the Admin Server page:

1. Log in as a user with the Oracle WebLogic Server 'sysmanager' role.

2. Click the Administration tray in the portal navigation bar. The Administration selections are displayed.

3. Click Admin Server.

Element

Description

Server Status link

Displays the current Content Server status on the Admin Server home page. Use the Oracle WebLogic Server Administration Console to start, stop, or restart the content server.

Component Manager link

Displays the Component Manager Page. Use this page to view, enable, and disable content server components. From this page you also can access the Advanced Component Manager Page.

General Configuration link

Displays the Admin Server: General Configuration Page. Use this page to view or modify general content server configuration.

Content Security link

Displays the Admin Server: Content Security Page, which contains the same information as shown on the System Properties: Content Security Tab. Use this page to view or modify content security configuration.

Internet Configuration link

Displays theAdmin Server: Internet Configuration Page, which contains the same information as shown on the System Properties: Internet Tab. Use this page to view or modify internet configuration for the content server.

View Admin Output link

Displays the Admin Server Output Page. Use this page to view console output.

View Server Logs link

Displays the list of content server log files.

View Providers link

Displays the Providers Page.

System Audit Information

Displays the System Audit Information Page, which provides general information about the content server, plus information on localization, tracing sections, cache, configuration entry, and component reports..

A.1.1.2 Admin Server Status Page

The Server Status page displays the current status of the Content Server; for example, Running. To access this page, click the Server Status link on the Admin Server Page.

Element

Description

Current Status

Displays the current status of the content server.

Home Page button

Displays the content server Home page.

Administration button

Displays the content server Administration page, which shows icons and names for administrative functions.

A.1.1.3 Admin Server Output Page

The Admin Server Output page displays the Java output of the Admin Server, which includes status and error messages for troubleshooting. To access this page, click the View Admin Output link on the Admin Server Page.

Element

Description

Refresh Page button

Refreshes the output messages.

Clear button

Clears the output messages. The output will not be displayed until the Content Admin service is restarted.

Output messages

Shows status and error messages for the Admin Server.

A.1.1.4 Administration Page

The Administration page displays icons and names which are links to Content Server administration functions. To access this page, click Administration on the Admin Server Status Page.

Element

Description

Content Server Logs link

Displays the Content Server Logs Screen.

Archiver Logs link

Displays the Archiver Log Screen.

Actions for Instance link

Displays current actions for the Content Server instance.

Admin Applets link

Displays the Admin Applets screen, which provides links for several administration applications.

Configuration for Instance link

Displays the Configuration Information Page.

System Audit Information link

Displays the System Audit Information Page.

Providers link

Displays the Providers Page.

Filter Administration link

Displays the Configure Web Server Filter Page.

Oracle Query Optimizer link

Displays the Oracle Query Optimizer Page.

File Store Provider link

Displays the FileStore Provider Information Page.

Connection Passwords link

Displays the Proxied Connection Authentication/Authorization Information Screen.

Credential Maps link

Displays the Credential Maps Screen.

Config Migration Admin link

Displays the Config Migration Admin Screen.

Admin Server link

Displays the Admin Server Page.

Environment Packager link

Displays the Environment Packager Page.

Conversion Options link

Displays Inbound Refinery conversion options. For details, see Oracle Fusion Middleware Administrator's Guide for Conversion.

Conversion Job Status link

Displays Inbound Refinery conversion job status information. For details, see Oracle Fusion Middleware Administrator's Guide for Conversion.

IBR Provider Status link

Displays Inbound Refinery provider status information. For details, see Oracle Fusion Middleware Administrator's Guide for Conversion.

A.1.2 System Properties Configuration Interface

The following screens are used to configure system properties for Content Server:

- System Properties Page

- General Options Configuration

- Content Security Configuration

- Internet Information Configuration

- System Properties: Database Tab

- System Properties: Server Tab

- System Properties: Paths Tab

A.1.2.1 System Properties Page

The System Properties utility can be used to configure the system options and functionality of the content server. It can be started only as a standalone application from the computer where the content server is installed.

Element

Description

Options tab

Used to set optional functionality for the content server.

Content Security tab

Used to set options related to content item security.

Internet tab

Used to set options related to content server interaction with web entities

Database tab

Used to set database options.

Server tab

Used to set optional functionality for the content server.

Localization tab

Used to set localization options.

Paths tab

Used to set content server directory paths.

OK button

Saves the changes and closes the System Properties screen. You must restart the content server for any changes to take effect.

Cancel button

Closes the System Properties screen without saving any changes.

A.1.2.2 General Options Configuration

You can set general options on the System Properties: Options Tab or on the Admin Server: General Configuration Page.

You must restart the Content Server for any configuration changes to take effect.

A.1.2.2.1 System Properties: Options Tab

You can set general options on the System Properties: Options Tab. You can run this application in standalone mode from the computer where the content server is installed. The method required to start these programs differs slightly between Windows and UNIX installations.

Element

Description

Allow override format on check in check box
(IsOverrideFormat)

Clear: Users cannot select the format of a document during checkin. This is the default.
Selected: Users can select the format of a document during checkin. This is useful in the following situations:

- When an application's default extension is not used for a file name. For example, a Microsoft Word document named customer.ltr does not have the default application extension .doc, but a contributor could select Microsoft Word Document from the Formats list on the checkin page to tell the content server how to convert the file.

- When the user must decide how the file should be converted and indexed. For example, say you have set Corel WordPerfect documents to be passed through as text files. If a contributor leaves the Format option on the checkin page as use default, the file is converted to text and full-text indexed automatically. If the contributor selects Corel WordPerfect Document, the file is passed through in its native format and is not full-text indexed.

Enable download applet check box
(DownloadApplet)

Selected: Users can select multiple files to check out or download at the same time. See the Oracle Fusion Middleware User's Guide for Content Server for details.
Clear: Users cannot check out or download multiple files. This is the default.

If the upload or download applet is enabled in the System Properties application or Admin Server, users can enable and disable the applet individually on their User Profile page. If an applet is disabled at the system level, the applet field is not displayed on User Profile pages.

Enable upload applet check box
(MultiUpload)

Selected: Users can check in multiple files as a single Zip file. For more information, see the Oracle Fusion Middleware User's Guide for Content Server.
Clear: Users cannot check in multiple files. This is the default.

Enable search keyword highlighting check box
(EnableDocumentHighlight)

Selected: All full-text search terms are highlighted in returned PDF, HTML, and text documents. This is the default.
Clear: Full-text search terms are not highlighted. This can shorten the time required to view a file from the Search Results page.

Enable Enterprise Search on Standard query pages check box
(EnterpriseSearchAsDefault)

Selected: Enterprise Search fields are displayed on search pages. The Enterprise Search add-on module must be purchased and installed.
Clear: Enterprise Search fields are not displayed on search pages. This is the default.

Automatically assign a Content ID on check in check box
(IsAutoNumber)

Selected: Content IDs are generated automatically as six-digit, sequential numbers.
Clear: A Content ID must be entered by the user during checkin. This is the default.

Auto Name/Number Prefix field
(AutoNumberPrefix)

If automatic Content ID generation is enabled, the string specified in this field is added as a prefix to the six-digit, sequential number.

Major Revision Label Sequence field
(MajorRevSeq)

Specifies how the first number or letter in a revision number is incremented.

Minor Revision Label Sequence field
(MinorRevSeq)

Specifies how the optional second number or letter in a revision number is incremented.

Enable Java Server Page (Jsp) check box
(IsJspServerEnabled)

Selected: Internal JSP support is enabled in the content server.
Clear: Internal JSP support is disabled.

See the Java Server Page and JavaBean Guide for more information.

This check box is displayed on the Admin Server General Configuration page, but not on the System Properties Options tab. See "System Properties: Server Tab".

Jsp Enabled Groups field
(JspEnabledGroups)

Specifies the security groups that are enabled for internal JSP support.
See the Java Server Page and JavaBean Guide for more information.

This field is displayed on the Admin Server General Configuration page, but not on the System Properties Options tab. See "System Properties: Server Tab".

Additional Configuration Variables field
(N/A)

Used to edit variables in the content server configuration file.

- Changes you make in this field will be reflected in the IntradocDir/config/config.cfg file when the content server is restarted.

- Placing a # symbol at the beginning of a line comments out that line.

A.1.2.2.2 Admin Server: General Configuration Page

To access this page, click Admin Server from the Administration tray in the portal navigation bar. Click the content server instance you want to access and select General Configuration from the Options for instance menu.

This page provides access to the same information as provided in the System Properties: Options Tab.

In the following table, the term in parentheses is the corresponding configuration setting defined in the IntradocDir/config/config.cfg file.

If you plan to use the Batch Loader to update and insert a large number of files on your content server system simultaneously, you must create a batch load file. Two of the optional parameters that you can include in your batch load file are the primaryOverrideFormat and alternateOverrideFormat. However, these options will only work as parameters in the batch load file if you enable the IsOverrideFormat configuration variable. You can set this variable in the System Properties application.

Element

Description

Allow override format on check in check box
(IsOverrideFormat)

Clear: Users cannot select the format of a document during checkin. This is the default.
Selected: Users can select the format of a document during checkin. This is useful in the following situations:

- When an application's default extension is not used for a file name. For example, a Microsoft Word document named customer.ltr does not have the default application extension .doc, but a contributor could select Microsoft Word Document from the Formats list on the checkin page to tell the content server how to convert the file.

- When the user must decide how the file should be converted and indexed. For example, say you have set Corel WordPerfect documents to be passed through as text files. If a contributor leaves the Format option on the checkin page as use default, the file is converted to text and full-text indexed automatically. If the contributor selects Corel WordPerfect Document, the file is passed through in its native format and is not full-text indexed.

Enable download applet check box
(DownloadApplet)

Selected: Users can select multiple files to check out or download at the same time. See the Oracle Fusion Middleware User's Guide for Content Server for details.
Clear: Users cannot check out or download multiple files. This is the default.

If the upload or download applet is enabled in the System Properties application or Admin Server, users can enable and disable the applet individually on their User Profile page. If an applet is disabled at the system level, the applet field is not displayed on User Profile pages.

Enable upload applet check box
(MultiUpload)

Selected: Users can check in multiple files as a single Zip file. See the Oracle Fusion Middleware User's Guide for Content Server.
Clear: Users cannot check in multiple files. This is the default.

Enable search keyword highlighting check box
(EnableDocumentHighlight)

Selected: All full-text search terms are highlighted in returned PDF, HTML, and text documents. This is the default.
Clear: Full-text search terms are not highlighted. This can shorten the time required to view a file from the Search Results page.

Enable Enterprise Search on Standard query pages check box
(EnterpriseSearchAsDefault)

Selected: Enterprise Search fields are displayed on search pages. The Enterprise Search add-on module must be purchased and installed.
Clear: Enterprise Search fields are not displayed on search pages. This is the default.

Enable Accounts check box

Selected: Accounts are functional on the content server.
Clear: Accounts are not functional on the content server.

Automatically assign a document name on check in check box
(IsAutoNumber)

Selected: Content IDs are generated automatically as six-digit, sequential numbers.
Clear: A Content ID must be entered by the user during checkin. This is the default.

Auto Name/Number Prefix field
(AutoNumberPrefix)

If automatic Content ID generation is enabled, the string specified in this field is added as a prefix to the six-digit, sequential number.

Major Revision Label Sequence field
(MajorRevSeq)

Specifies how the first number or letter in a revision number is incremented.

Minor Revision Label Sequence field
(MinorRevSeq)

Specifies how the optional second number or letter in a revision number is incremented.

Enable Java Server Page (Jsp) check box
(IsJspServerEnabled)

Selected: Internal JSP support is enabled in the content server.
Clear: Internal JSP support is disabled.

See the Java Server Page and JavaBean Guide for more information.

This check box is displayed on the Admin Server General Configuration page, but not on the System Properties Options tab. See "System Properties: Server Tab".

Jsp Enabled Groups field
(JspEnabledGroups)

Specifies the security groups that are enabled for internal JSP support.
See the Java Server Page and JavaBean Guide for more information.

This field is displayed on the Admin Server General Configuration page, but not on the System Properties Options tab. See "System Properties: Server Tab".

Additional Configuration Variables field
(N/A)

Used to edit variables in the content server configuration file.

- Changes you make in this field will be reflected in the IntradocDir/config/config.cfg file when the content server is restarted.

- Placing a # symbol at the beginning of a line comments out that line.

A.1.2.3 Content Security Configuration

You can set content security options on the System Properties: Content Security Tab or on the Admin Server: Content Security Page.

You must restart the Content Server for any configuration changes to take effect.

A.1.2.3.1 System Properties: Content Security Tab

You can set content security options on the System Properties: Content Security Tab. You can run this application in standalone mode from the computer where the content server is installed. The method required to start these programs differs slightly between Windows and UNIX installations.

Element

Description

Allow get copy for user with read privilege check box
(GetCopyAccess)

Selected: Users with only Read permission to a content item's security group can get a copy of the native file.
Clear: Users with only Read permission to a content item's security group cannot get a copy of the native file.

Allow only original contributor to check out check box
(ExclusiveCheckout)

Selected: Only the Author or a user with Admin permission to a content item's security group can check out the content item.
Clear: Any user with Write permission to a content item's security group can check out the content item.

Allow author to delete revision check box
(AuthorDelete)

Selected: The Author of a content item can delete the content item, even if they do not have Delete permission to the content item's security group.
Clear: All users must have Delete permission to a content item's security group to delete the content item.

Show only known accounts check box
(ShowOnlyKnownAccounts)

Selected: Only predefined accounts appear in the Accounts option list on checkin and search pages.
Clear: User-defined accounts and predefined accounts appear in the Accounts option list on checkin and search pages.

A.1.2.3.2 Admin Server: Content Security Page

You can set content security options on the Admin Server: Content Security Configuration Page.

To access this page, click Admin Server from the Administration tray in the portal navigation bar. Select Content Security from the Options for instance menu.

This page provides access to the same information as provided on the System Properties: Content Security Tab.

In the following table, the term in parentheses is the corresponding configuration setting defined in the IntradocDir/config/config.cfg file.

Element

Description

Allow get copy for user with read privilege check box
(GetCopyAccess)

Selected: Users with only Read permission to a content item's security group can get a copy of the native file.
Clear: Users with only Read permission to a content item's security group cannot get a copy of the native file.

Allow only original contributor to check out check box
(ExclusiveCheckout)

Selected: Only the Author or a user with Admin permission to a content item's security group can check out the content item.
Clear: EuAny user with Write permission to a content item's security group can check out the content item.

Allow author to delete revision check box
(AuthorDelete)

Selected: The Author of a content item can delete the content item, even if they do not have Delete permission to the content item's security group.
Clear: All users must have Delete permission to a content item's security group to delete the content item.

Show only known accounts check box
(ShowOnlyKnownAccounts)

Selected: Only predefined accounts appear in the Accounts option list on checkin and search pages.
Clear: User-defined accounts and predefined accounts appear in the Accounts option list on checkin and search pages.

A.1.2.4 Internet Information Configuration

You can set Internet options on the System Properties: Internet Tab or on the Admin Server: Internet Configuration Page.

You must restart the content server for any configuration changes to take effect.

A.1.2.4.1 System Properties: Internet Tab

You can set Internet options on the System Properties: Internet Tab. You can run this application in standalone mode from the computer where the content server is installed. The method required to start these programs differs slightly between Windows and UNIX installations.

Element

Description

HTTP Server Address field*
(HttpServerAddress)

The name of the web server.
For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

Mail Server field
(MailServer)

The e-mail server used to send e-mail notifications from the content server. This generally takes the form of mail.company.com. If applicable, make sure to allow for sending mail through a firewall.

Administrator Mail Address field
(SysAdminAddress)

The e-mail address that the content server uses to send e-mail notifications. This address will receive returned messages if delivery failures occur.

SMTP Port field*
(SmtpPort)

The port used for SMTP communications. This is typically 25, but consult your network system administrator for any changes.
For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

Http Relative Web Root field*
(HttpRelativeWebRoot)

The relative web root that is used by the web server to resolve URLs to files in the IntradocDir/weblayout/ directory.
For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

Use Secure Sockets Layer check box*
(UseSSL)

Selected: A Secure Sockets Layer (SSL)-enabled web server is being used.
Clear: A Secure Sockets Layer (SSL)-enabled web server is not being used.

For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

A.1.2.4.2 Admin Server: Internet Configuration Page

You can set Internet options from the Admin Server: Internet Configuration page.

To access this page, click Admin Server from the Administration tray in the portal navigation bar. Select Internet Configuration from the Options for instance menu.

This page provides access to the same information as provided on the System Properties: Internet Tab.

In the following table, the term in parentheses is the corresponding configuration setting defined in the IntradocDir/config/config.cfg file.

Element

Description

HTTP Server Address field*
(HttpServerAddress)

The hostname and port of the web server.
For security reasons, this field cannot be changed using the Admin Server. You must change the field using the standalone application.

Mail Server field
(MailServer)

The e-mail server used to send e-mail notifications from the content server. This generally takes the form of mail.company.com. If applicable, make sure to allow for sending mail through a firewall.

Administrator Mail Address field
(SysAdminAddress)

The e-mail address that the content server uses to send e-mail notifications. This address will receive returned messages if delivery failures occur.

SMTP Port field*
(SmtpPort)

The port used for SMTP communications. This is typically 25, but consult your network system administrator for any changes.
For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

Http Relative Web Root field*
(HttpRelativeWebRoot)

The relative web root that is used by the web server to resolve URLs to files in the IntradocDir/weblayout/ directory.
For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

Use Secure Sockets Layer field*
(UseSSL)

True: A Secure Sockets Layer (SSL)-enabled web server is being used.
False: A Secure Sockets Layer (SSL)-enabled web server is not being used.

For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

A.1.2.5 System Properties: Database Tab

You can set JDBC (Java Database Connectivity) configuration options on the System Properties: Database Tab. For security reasons, the Admin Server cannot be used to configure the database. You must use the standalone application to configure the database.

You must restart the content server for any configuration changes to take effect.

In the following table, the term in parentheses is the corresponding configuration setting defined in the IntradocDir/config/config.cfg file.

Element

Description

Use Java Database Connectivity check box
(IsJdbc)

Selected: JDBC is enabled, and the options are active. This is the default.
Clear: JDBC is disabled.

JDBC options
(N/A)

The type of database driver.

- For all options except Other JDBC Driver, the JDBC Driver Name and JDBC Connection String are entered automatically.

- For the Other JDBC Driver option, you must enter the correct JDBC Driver Name and JDBC Connection String.

Enable database preserve case check box
(DatabasePreserveCase)

Selected: The database is case sensitive (such as Oracle or Informix).
Clear: The database is not case sensitive.

Specify Database Driver Classpath check box

Selected: A database driver classpath must be specified in the Database Driver Classpath field to support a database connection.
Clear: No database driver classpath is required.

Database Driver Classpath field

The classpath for the database driver.

JDBC Driver Name field
(JdbcDriver)

The name of the JDBC driver.

- For all options except Other JDBC Driver, the correct name is entered automatically.

- For the Other JDBC Driver option, you must enter the correct driver name.

JDBC Connection String field
(JdbcConnectionString)

The connection string for the JDBC driver.

- For all options except Other JDBC Driver, the correct connection string is entered automatically.

- For the Other JDBC Driver option, you must enter the correct connection string.

The connection string format is JDBC:ODBC:name, where name is the System Data Source Name. To find this name on a Windows system, perform the following steps:

1. Click Programs in the Start menu

2. Click Administrative tools in the Programs menu

3. Click Data Sources in the Administrative tools, to open ODBC screen.

4. Select the system DSN tab on the ODBC Data Source Administrator screen. The System Data Source Names are displayed on this tab

JDBC User Name field
(JdbcUser)

The user name that owns the tables inside the database.

JDBC User Password field
(JdbcPassword)

The password for the user name that owns the tables inside the database.

A.1.2.6 System Properties: Server Tab

You can set content server options on the System Properties: Server Tab. For security reasons, the Admin Server cannot be used to configure these options. You must use the standalone application to configure options.

You must restart the content server for any configuration changes to take effect.

In the following tables, the term in parentheses is the corresponding configuration setting defined in the IntradocDir/config/config.cfg file.

Element

Description

System Locale list
(SystemLocale)

Specifies how the content server handles several language-specific issues such as the language of the user interface, stemming rules, sort order, and date/time format.

System Timezone list
(SystemTimeZone)

The time zone in which the content server system is located. The specified time zone can be used to present times relative to other time zones, such as correcting for Daylight Savings Time, or presenting the date and time of a content item on a content server in North America to users in Europe.
If the Detect timezone automatically option is selected, a time zone is not specified in the configuration file, and the content server uses the time zone set for the computer's operating system.

Instance Menu Label field
(InstanceMenuLabel)

The instance name that is displayed in the Windows Start menu.

Instance Description field
(InstanceDescription)

Not currently used.

IP Address Filter field
(SocketHostAddressSecurity Filter)

Restricts access to the content server to computers with a specified IP address.

- By default, this field is pre-filled with the IP address of the local host (127.0.0.1).

- You can specify multiple IP addresses, separated by pipes ( | ). Make sure that there are no spaces on either side of the pipe character. (For example, 127.0.0.1|10.10.50.143)

- You can use wildcards in this field, * for zero or many characters, and ? for any one character. (For example, 10.10.3.*)

- Generally, use only the IP Address Filter field or Hostname Filter field, not both. (IP Address Filter is more commonly used.)

Proxy Password field

Specifies the password for the proxy.

Confirm Password field

Confirms the password.

Execute Java Server Page (JSP) check box
(IsJspServerEnabled)

Selected: Internal JSP support is enabled in the content server.
Clear: Internal JSP support is disabled.

See the Java Server Page and JavaBean Guide for more information.

In the Admin Server, this check box is displayed on the Admin Server: General Configuration Page.

JSP Enabled Groups field
(JspEnabledGroups)

Specifies the security groups that are enabled for internal JSP support.
See the Java Server Page and JavaBean Guide for more information.

In the Admin Server, this field is displayed on the Admin Server: General Configuration Page.

A.1.2.7 System Properties: Paths Tab

You can use the System Properties: Paths Tab to change the location of the help browser, Java classpath, and the shared directory path. For security reasons, the Admin Server cannot be used to configure the path options. You must use the standalone application for this configuration.

You must restart the content server for any configuration changes to take effect.

In the following table, the term in parentheses is the corresponding configuration setting defined in the DomainHome/ucm/cs/bin/intradoc.cfg file.

Element

Description

Browser Executable Path field
(WebBrowserPath)

The location of the browser executable that will be used to display the online help from the standalone Overview of Administration Utilities and Applets.

- For Windows 2000 systems, the default is c:/Program Files/Internet Explorer/iexplore.exe.

- For UNIX systems, the path for the web browser is requested during installation.

Browse button
(N/A)

Used to navigate to and select the executable file for the Help browser.

Custom Java Classpath field
(BASE_JAVA_CLASSPATH_custom)

Specifies the path to the Java class files.

- By default, the CLASSPATH points at classes/, shared/classes/, and shared/classes/server.zip.

- If an Oracle or Informix database is used, the CLASSPATH will include a JDBC driver zip file, such as shared/classes/classes111.zip.

Shared Directory Path field
(IdcHomeDir)

Defines the path to the shared directory.

- This directory contains shared files for the content server, such as resource files, template files, and binaries such as mkvdk.

- If the Inbound Refinery is installed, this directory contains the conversion engines, and all Inbound Refinery temp work is done in this directory and its subdirectories.

- The default is IdcHomeDir/resources/.

A.1.3 Indexing and Search Content Interface

The following screens are used when working with the search index, configuring zone text fields, and searching content using the Oracle Query Optimizer component:

- Repository Manager: Indexer Tab

- Automatic Update Cycle Screen

- Collection Rebuild Cycle Screen

- Indexer Rebuild Screen

- Oracle Query Optimizer Page

- Zone Fields Configuration Page

- Hint Rules Configuration Page

- Edit Query Hint Rules Table

- Query Converter Page

- Hint Cache Updater Page

- Admin Actions Page

A.1.3.1 Repository Manager: Indexer Tab

The Indexer tab of the Repository Manager is used to monitor, run, and configure Indexer update cycles and collection rebuild cycles. It also provides access to the OracleTextSearch feature for fast rebuilds. To access the Repository Manager application, click the Administration tray in the portal navigation bar, then Admin Applets, then Repository Manager. To access the Indexer functions, click the Indexer tab on the Repository Manager window.

For more details about the Repository Manager administration application, see "Managing Repository Content" in the Oracle Fusion Middleware Application Administrator's Guide for Universal Content Management.

Element

Description

Automatic Update Cycle pane

Incrementally updates the index database automatically approximately every five minutes, regardless of whether an event (such as file checkin) has triggered the Indexer.

Collection Rebuild Cycle pane

The search index is entirely rebuilt, and the old index collection is replaced with a new index collection when the rebuild is successfully completed.

State field

The current place in the indexing cycle:
Initialization: The indexing cycle is being initialized.

Adding to collection...: Revisions are being indexed.

Finished: The indexing cycle is completed or has been canceled.

Status field

The status of the indexing cycle:
Idle: No indexing cycles are in process.

Active: An indexing cycle is currently running.

Interrupted: The indexing cycle was interrupted, either by a suspension or an unexpected event (such as a power, database, or file system failure).

Suspending: The indexing cycle is being suspended.

Cancelling: The indexing cycle is being canceled.

Start Date field

The date and time the last indexing cycle started.

Finish Date field

The date and time the last indexing cycle finished.

Active Date field

If the indexing cycle is currently active, the date and time the cycle became active.

Indexer Counters field

Counter values for the current indexing cycle.
Total: The total number of documents indexed.

Full Text: The number of full-text indexed documents.

Meta Only: The number of documents for which only metadata has been indexed.

Delete: The number of documents deleted from the search index.

Start/Restart button

Begins the indexing cycle, or restarts a cycle that was suspended or interrupted. Corresponds to the Start index update and Start index rebuild links in the Actions section of the Administration tray. These links enable you to remotely manage indexing functions.

Suspend button

Stops the indexing cycle and permits a restart. Corresponds to the Suspend index update and Suspend index rebuild links in the Actions section of the Administration tray. These links enable you to remotely manage indexing functions.

Cancel button

Stops the indexing cycle but does not permit a restart. Corresponds to the Cancel index update and Cancel index rebuild links in the Actions section of the Administration tray. These links enable you to remotely manage indexing functions.

Configure button

Displays either the Automatic Update Cycle Screen or the Collection Rebuild Cycle Screen, which enable you to adjust the files per batch, checkpoint, and debug level.

A.1.3.2 Automatic Update Cycle Screen

The Automatic Update Cycle screen is used to configure how the Indexer automatically indexes new files and revisions. To access this screen, click Configure in the Automatic Update Cycle pane of the Repository Manager: Indexer Tab.

Element

Description

Content Items Per Indexer Batch field

The maximum number of files that the search index will process simultaneously. The default is 25. For example, 25 files are indexed together, then the next 25 files are indexed. However, if one item fails, then the batch is processed again.
Thus, if you set this value to 2000 and a document fails, the entire batch would be reprocessed. This would take longer than if you use the default setting and an item fails. But, if there are no failures in the batch, then setting this value higher accelerates the process.

The only time you would change this setting to one (1) is if you are experiencing problems with the search engine indexing large and complicated files.

Content Items Per Checkpoint field

The number of files that will go through all relevant indexing states at a time. You can have multiple batches of files indexed per checkpoint. After the checkpoint is reached, some merging of the collection is done before the next batch is processed.
If this is set to a high value and you try to cancel a rebuild or an update cycle, the Repository Manager does not stop processing until the checkpoint is reached. However, setting the value too low slows down the indexing process.

Indexer Debug Level list

The Indexer debug level. The more debug information listed in the server window, the slower the indexing progresses. The following list shows the debug levels from the least to the most debug information:
none: No information for each file access is displayed, and no log will be generated.

verbose: Displays information for each file accessed. Indicates indexed, ignored, or failed, and generates a full report.

debug: Displays the medium level of information, which is specifically functional.

trace: Displays the lowest level of information for each activity performed.

all: Displays the highest level of debug information.

Indexer Auto Updates check box

Selected: The index database is updated automatically.
Clear: The index database is not updated automatically.

A.1.3.3 Collection Rebuild Cycle Screen

The Configure Collection Rebuild Cycle screen is used to configure how the Indexer rebuilds the search collection. To access this screen, click Configure in the Collection Rebuild Cycle pane of the Repository Manager: Indexer Tab.

Element

Description

Content Items Per Indexer Batch field

The maximum number of files that the search index will process simultaneously. The default is 25. For example, 25 files are indexed together, then the next 25 files are indexed. However, if one item fails, then the batch is processed again.
Thus, if you set this value to 2000 and a document fails, the entire batch would be reprocessed. This would take longer than if you use the default setting and an item fails. But, if there are no failures in the batch, then setting this value higher accelerates the process.

The only time you would change this setting to one (1) is if you are experiencing problems with the search engine indexing large and complicated files.

Content Items Per Checkpoint field

The number of files that will go through all relevant indexing states at a time. You can have multiple batches of files indexed per checkpoint. After the checkpoint is reached, some merging of the collection is done before the next batch is processed.
If this is set to a high value and you try to cancel a rebuild or an update cycle, the Repository Manager will not stop processing until the checkpoint is reached. However, setting the value too low will slow down the indexing process.

Indexer Debug Level list

The Indexer debug level. The more debug information listed in the server window, the slower the indexing progresses. The following list shows the debug levels from the least to the most debug information:
none: No information for each file accessed is displayed.

verbose: Displays information for each file accessed. Indicates indexed, ignored, or failed.

debug: Displays the medium level of information.

trace: Displays the lowest level of information.

all: Displays the highest level of information.

Database and Database Full-Text Search do not support indexer debug levels, so only the none option is displayed if you use a database for search and index.

A.1.3.4 Indexer Rebuild Screen

If you are using OracleTextSearch as your search and indexing engine, when you use the Collection Rebuild Cycle Screen on the Repository Manager: Indexer Tab, you can choose to use the Indexer Rebuild function. Using Indexer Rebuild causes the search engine to add new information to the search collection without requiring a full collection rebuild. It does not cause all the information (metadata and full-text) to be re-indexed.

When you click Start on the Collection Rebuild Cycle Screen, the Indexer Rebuild screen is displayed. To use this function, click OK. To not use this function, clear the Use fast rebuild check box and click OK.

A.1.3.5 Oracle Query Optimizer Page

The Oracle Query Optimizer utility provides several methods for optimizing queries. To access the Oracle Query Optimizer page, on the Administration Page select Oracle Query Optimizer.

Element

Description

Hint Rules Configuration link

Displays the Hint Rules Configuration Page.

Query Converter link

Displays the Query Converter Page.

Hint Cache Updater link

Displays the Hint Cache Updater Page.

A.1.3.6 Zone Fields Configuration Page

Access the Zone Fields Configuration page by selecting Zone Fields Configuration from the Administration tray in the portal navigation bar.

Element

Description

Search Engine drop-down list

Select the search engine to be used to search the zone text fields (either Database or DatabaseFullText).

Zone Text Fields list

Lists the zone text fields for the selected search engine. You can use the [Ctrl] and [Shift] keys on your keyboard to select multiple fields.

Text Fields list

Lists the available text fields for selected search engine.
By default, text fields with a field length of 20 or less characters are not included in the Text Fields list. You can change this setting by modifying the MinFullTextFieldLength configuration variable.

Right and left arrow buttons

Move selected fields between the Zone Text Fields and Text Fields lists.

Update button

Enables text fields in the Zone Text Fields list as zone text fields, and disables text fields in the Text Field list. Parses the text within all zone text fields and creates a full-text index that can be queried using the Contains search operator.
Changing a text field to a zone text field can be a very time-consuming operation. The amount of time it takes to parse the text and create the full-text index depends on the number of content items in the content server and the amount of text stored in the text field. However, when the text field has been indexed, you should not experience significant performance issues when updating and adding content items.

Reset button

Reverts the Zone Text Fields and Text Fields lists to the last saved lists.

Note:
Custom text fields (the Comments text field and any customer-created text fields) are shared between the Database and DatabaseFullText search engines, and therefore changing the status of these text fields for one search engine also applies the changes to the other search engine. Standard text fields (Author, Content ID, Content Type, Title, and so no) can be enabled or disabled independently for each search engine.

A.1.3.7 Hint Rules Configuration Page

The hint rules table contains the rules that the query optimizer uses to select hints during the Query Optimization Process. The rules in this table are displayed on the Hint Rules Configuration page. To access this page, select the Administration tray in the portal navigation bar, then Oracle Query Optimizer, then Hint Rules Configuration.

Element

Description

Show/Hide hint rule editor toggles

By default, the Edit Query Hint Rules Table is displayed only after accessing the Hint Rules Configuration page. One toggle switch is located above the configuration table and the other is positioned below the table. When the Edit Query Hint Rules Table is displayed, both toggles convert to Hide hint rule editor.
Show hint rule editor: Displays the Hint Rule Editor.

Hide hint rule editor: Conceals the Hint Rule Editor.

Hint rules configuration table columns

Key: The unique name to identify the rule.
Table: Identifies the specific database table.

Column: Identifies the specific column within the database table listed in the Table column.

Operator: A comma-delimited list of allowable operators.

Index: Identifies the specific index to use in the optimized queryif the condition meets the hint rule requirements.

Order: Contains the preferred order to use when the rule is included in the hint rules table.

Values: This column is Idoc scriptable. This column can only be defined when the Operators column has one of two specific values.

AllowMultiple: Indicates whether the defined index is used with other indexes.

Disabled: Indicates whether a hint rule has been disabled.

A.1.3.8 Edit Query Hint Rules Table

The Edit Query Hint Rules Table provides a way to add, remove, enable, or disable rules for the Hint Rule Editor. The Hint Rule Editor is accessed by clicking one of the Show hint rule editor toggles on the Hint Rules Configuration Page and is displayed below the hint rules configuration table.

Element

Description

Key field

The unique name that identifies the hint rule.

Table field and menu

Identifies the database table associated with the hint rule. The menu lists the current database tables. Selecting a table from the menu automatically populates the Column field, Column menu options, Index field and Index menu options.

Column field and menu

Identifies the database table column associated with the hint rule. Selecting a column from the menu automatically populates the Index field and Index menu options.

Index field and menu

Identifies the index associated with the hint rule.

Operators field and menu

Identifies the specific operator(s) associated with the hint rule. Valid options include:
equal: Compares records to find equal values.

like: Compares records to find similar values.

in: Compares records to find values equal to any member of the specified item(s). Using this operator enables you to define the Values field.

greater: Compares records to find larger values on the left.

ge: (greater than or equal to) Compares records to find equal values or larger values on the left.

le: (less than or equal to) Compares records to find equal values or smaller values on the left.

less: Compares records to find larger values on the right.

notEqual: Compares records to find different values.

notIn: Compares records to find values that are not equal to any member of the specified item(s). Using this operator enables you to define the Values field.

notLike: Compares records to find dissimilar values.

generic: This operator is necessary if multiple operators are used in the conditions and are connected by an OR conjunction. For example: dIndexerState IS NULL OR dIndexerState IN ('N', 'Y').

range: This operator can be applied to an Integer field or a Date field. This operator is necessary when the Values field is defined with a valid range of values that would cause the hint to be applied. Using this operator enables you to define the Values field.

Order menu

In descending order from 5 to 1, indicates the preference value of the hint rule. During the optimization process, the highest ranked hint rule that meets the condition's requirements is selected.

Values field

Specifies applicable quantities when used with the operators in, notIn, and range; see the Operators field on the Edit Query Hint Rules Table.

AllowMultiple menu

Available options include:
Yes: The defined index can be used with other indexes.

No: The defined index must be used alone.

Add/Enable button

Used to add/edit a hint rule or activate a disabled hint rule.

Disable button

Deactivates the selected rule.

Remove button

Deletes the selected hint rule from the hint rules table. Only rules added using the Hint Rule Editor can be removed.

A.1.3.9 Query Converter Page

The Query Converter page displays the result of a converted query and enables you to modify a converted query by adding, editing, or deleting conditions from the WHERE clause. Modifying a converted query enables you to see exactly what will be executed when the query is submitted. Converted queries can optionally include data sources. The Query Converter page is accessed from the Hint Rules Configuration Page by selecting the Administration tray in the portal navigation bar, then Oracle Query Optimizer, then Query Converter.

The following figures show two types of query converter pages: a page that uses a data source, and a page that does not use a data source.

Element

Description

Use Data Source check box

This check box acts as a toggle switch to display or hide the fields related to converting a data source.
Selected: On the Query Converter page, displays all the fields.

Clear: On the Query Converter page, hides the DS Name menu and text area and the Additional Parameters field on the Hint Cache Updater Page.

DS Name menu and text area

The menu lists the available data source names and, when you select one, the text area displays the current contents of the data source query.

Additional Parameters field

One or more variables that are evaluated for the data source used to generate a query related to a specific environment.

Where Clause/Query field

where Clause: This field is displayed when the Use Data Source check box is selected. Enables you to enter additional conditions that are appended to the existing WHERE clause in the data source. You can copy and paste an existing WHERE clause or enter it manually.
Query: This field displays when the Use Data Source check box is clear. Enables you to enter a full query to be evaluated. You can copy and paste an existing query or enter it manually.

Convert Query button

Submits the information for the data source or query to be evaluated using the Query Optimization Process. The submitted data source or query is converted from a standard query to an optimized query that uses customized hints.

A.1.3.10 Hint Cache Updater Page

The Hint Cache Updater Page enables you to add a new entry, edit an existing entry, or remove an existing entry which enables you to fine tune query hints. Additionally, you can monitor and edit entries in the hint cache at run time to customize them for specific queries. The Hint Cache Updater page is accessed from the Hint Rules Configuration Page by selecting the Administration tray in the portal navigation bar, then Oracle Query Optimizer, then Hint Cache Updater.

The following figures show two types of query converter pages: a page that uses a data source, and a page that does not use a data source.

Element

Description

Use Data Source check box

This check box acts as a toggle switch to display or hide the fields related to managing the data source-based entries in the hint cache.
Selected: On the Hint Cache Updater page, displays all the fields.

Clear: On the Hint Cache Updater page, hides the DS Name menu and text area and the Additional Parameters field.

DS Name menu and text area

The menu lists the available data source names and, when you select one, the text area displays the current contents of the data source query.

Additional Parameters field

One or more variables that are evaluated for the data source used to generate a query related to a specific environment.

where Clause/Query field

where Clause: This field is displayed when the Use Data Source check box is selected. Enables you to enter additional conditions that are appended to the existing WHERE clause in the data source. You can copy and paste an existing WHERE clause or enter it manually.
Query: This field displays when the Use Data Source check box is clear. Enables you to enter a full query to be evaluated. You can copy and paste an existing query or enter it manually.

Hints field

Enter any additional hints for the data source or query. If you enter one or more Content Server Hints, the Oracle Query Optimizer component will consider them as default hints and they will not go through the Query Optimization Process. If you enter multiple hints, the feature will look for the best hint and, if possible, select multiple hints.

Check Cache button

Evaluates the submitted query and checks the hint cache to determine if matching hints already exist. If so, they are returned. If not, the message, Hint does not exist in cache is displayed.
With data source: Combines the WHERE clause and hints and applies the additional parameters before submitting the query for evaluation.

Without data source: Combines the query and hints before submitting the query for evaluation.

Update Cache button

Ensures that the data source or query will always use the specified hints because the hint cache is updated. Thus, clicking this button results in a manual overwrite of the previously defined hint cache. From now on, the new hints will be used with this particular query.

Remove button

Removes the information entered into any of the fields for the specified query.

A.1.3.11 Admin Actions Page

You can use the Admin actions status page to remotely view the status and perform basic administration tasks for localization indexing, automatic update cycle, and collection rebuild cycle functions. To access this page, select the Administration tray in the portal navigation bar, then click Admin Actions.

Element

Description

Weblayout Publishing area

Displays status information and actions for weblayout publishing. You can click to publish dynamic layout files, to publish static layout files, and to view a progress trace.

Schema Publishing area

Displays status information and actions for schema publishing. You can click links to publish schema configuration, publish schema configuration and data, and to view a progress trace.

Localization Indexing area

Displays status information and actions for localization indexing. You can click links to build a string index.

Automatic Update Cycle area

Displays status information and actions for the document index update cycle. You can click links to start, suspend, and cancel an update cycle.

Collection Rebuild Cycle area

Displays status information and actions for the document index rebuild cycle. You can click links to start, suspend, and cancel a rebuild cycle.

A.1.4 File Store Administration Interface

The FileStore Provider component is installed and enabled by default. This component adds the following pages to Content Server:

- Partition Listing Page

- Add/Edit Partition Page

- FileStore Provider Information Page

- Edit File Store Provider Page

- Add/Edit Storage Rule Page

- Path Information Screen

A.1.4.1 Partition Listing Page

The Partition Listing page displays a list of all current partitions, indicating their root and status. To access the Partition Listing page, select the Administration tray in the portal navigation bar and click File Store Administration. Elements of each partition listed can be modified using the Add/Edit Partition Page, and their values are stored in the PartitionList resource table in the fsconfig.hda file, located in the IntradocDir/data/filestore/config directory.

Element

Description

Partition Name

Displays the name of the partition as defined when the partition was created using the Add/Edit Partition Page. The partition name is part of the path expression used by Content Server when storing content.

Partition Root

Displays the root level to where content is being stored for this partition and is one of the arguments passed to the algorithm used by Content Server to choose a storage location for content. This value can be a static string, such as C:/vault, an expression, such as $#env.VauldDir$, or an Idoc Script variable, such as $HttpWebRoot$.

Is Active

Displays whether a partition is active (TRUE) or not (FALSE). Active partitions are available to store content.

Action

Displays the item action menu for each partition, from which you can choose to edit or delete the partition.

Add Partition

Clicking Add Partition displays the Add/Edit Partition Page, which can be used to add and activate a new partition for use by Content Server.

A.1.4.2 Add/Edit Partition Page

The Add/Edit Partition Page is used to create and modify partitions used by Content Server to store content. To access the Add/Edit Partition page, click Add Partition on the Partition Listing Page. Values entered here are stored in the Partition List Table in the fsconfig.hda file, located in the IntradocDir/data/filestore/config/ directory.

Element

Description

Partition Name

Defines the unique name of the partition. The partition name is displayed on the Partition Listing Page and is part of the path expression used by Content Server to store content. As such, it must be unique for each partition created, and has the same character limitations as Idoc Script and HTML path expressions.

Partition Root

Defines the root level of the path to where content is stored for this partition and is one of the arguments passed to the algorithm used by Content Server to choose a storage location for content.

Capacity Check Interval

Specifies the interval used in determining the disk space available for use by this partition. Expressed in seconds. This argument may not work on all platforms.

Slack Bytes

Specifies the point at which a partition is full and can no longer accept content. If the available space on the partition is lower than the specified number of slack bytes, the partition no longer accepts new content.

Duplication Methods

Specifies how native files are treated when not converted to a web-viewable rendition. For example, many image files do not require a rendition to be web-viewable. Linking to the native file instead of copying them to the web path helps manage storage space.
copy (default): copies the native file to the web path.

link: Resolves the web path to the native file in the vault

Is Active

Specifies whether the partition is active and available for new content.

Update

Submits the information specified creates or updates the partition.

Reset

Resets the information to the previous state before updating the partition.

A.1.4.3 FileStore Provider Information Page

The FileStore Provider Information page for a FileStore provider displays information about the selected provider, including the connection state, last activity date, and the provider type, class, and connection.

To display the FileStore Provider Information page, click Info next to a FileStore provider on the Providers Page.

Click Edit on the FileStore Provider Information page to display the Edit File Store Provider Page, where details of the FileStore Provider can be modified.

A.1.4.4 Edit File Store Provider Page

The Edit File Store Provider page is used to modify the existing file store. To access the Edit File Store page, click Edit on the FileStore Provider Information Page.

The information entered on this page is stored in the provider.hda file located in the IntradocDir/data/providers/defaultfilestore directory. The default values will handle most storage scenarios.

Element

Description

Provider Name

Defines the name of the provider.

Provider Description

A descriptive phrase displayed on the Providers Page identifying the provider.

Provider Class

The path to the Java class file governing provider functionality. The default class file is BaseFileStore.

Connection Class

This is a path to a Java class file that is not applicable to Content Server. Do not enter a value.

Configuration Class

The path to the Java class file used to configure file store provider functionality.

Access Implementor

The path to the Java class file called to access content.

Descriptor Implementor

The path to the Java class file called when describing content.

Event Implementor

The path to the Java class file called when implementing an event, such as indexing or searching.

Metadata Implementor

The path to the Java class file called when needing information about content.

Storage Rules

Lists the storage rules used for the provider. Select the rule to edit, or select Add rule to create additional rules.

Edit Rule

Accesses the Add/Edit Storage Rule Page for adding or modifying storage rules.

A.1.4.5 Add/Edit Storage Rule Page

The Add/Edit Storage Rule page is used to confide how and where each provider stores content checked into Content Server. This page defines if content is stored on a file system or within a database, if a Web rendition is created, and how the paths to the content are constructed. To access the Add/Edit Storage Rule page, click Edit Rule next to the Storage Rules menu on the Edit File Store Provider Page.

Element

Description

File system only

Specifies that content checked into Content Server be stored only on a specified file system, and not in a database. This includes both the native and web-viewable files unless the Is Webless File Store option is enabled.

Is Webless File Store

Specifies that a web-viewable rendition content not be created.

JDBC Storage

Specifies that content checked into Content Server be stored only in a database, and not on a file system. This includes both the native and web-viewable files unless an option is selected from the Renditions choice list.

Renditions

Specifies a rendition to store on a file system when JDBC Storage is enabled.
No selection (default): Both the native and web-viewable renditions are stored in the database.

Web Files: Stores web-viewable renditions on a file system and native files in the database.

Vault Files: Stores native files on a file system and web-viewable files in the database.

Show Path Metadata

Expands the screen to display detailed information about the metadata used for constructing paths used by the provider.

Vault Path

The expression defining the path to the vault location where native content checked into Content Server server is stored for the provider using this rule.

Web-viewable Path

The expression defining the path on the file system to the web-viewable rendition.

Web URL File Path

The URL used to access the web-viewable rendition in a browser.

Important:
If the web root used in the web URL file path defined in the storage rule is something other than the default weblayout directory defined for Content Server, you must add an alias or virtual directory in your web server for the web root used in the storage rule. Otherwise, Content Server does not know where to access the file. For information on adding virtual directories to your web server, see the documentation that came with your web server.

A.1.4.6 Path Information Screen

The Path Information screen displays details about metadata used for constructing paths used by the provider. To view the Path Information screen, click Show Path Metadata on the Add/Edit Storage Rule Page.

A.1.5 Web Server Interface Screens

This section covers these topics:

- Configure Web Server Filter Page

- WebUrlMaps Screen

A.1.5.1 Configure Web Server Filter Page

The Configure Web Server Filter page is used to configure and troubleshoot Web server filter communication with Content Server. Because Oracle WebLogic Server handles Web server communication, most of the options on this page are not relevant except for the GZIP encoding option. The settings can still be modified and can be relevant if a separate Web server is used as an access point for this Content Server instance.

To access this page, click the Filter Administration link in the Administration tray in the portal navigation menu.

General Options

Description

Cache Timeout field

Sets the amount of time in minutes that the web server holds user credentials. To maintain the content server user credentials, you should select a finite time for the web server to cache user data.

Default Authentication field

The first time a user logs into the content server, a cookie is sent to the filter. If you change the default authentication from the default Basic to NTLM, the first time a user logs into the content server the user will not be prompted to log in again because their credentials will automatically be authenticated.

Disable GZIP Compression

For optimal performance, the content server compresses the HTML response pages. This option is useful for debugging purposes.
TRUE = Prevents the content server from compressing HTML response pages.

FALSE = Configures the content server to compress HTML response pages. This is the default setting.

When you select any of the logging options, a Web server filter log file is created as follows:

- Apache: IntradocDir/data/users/authfilt.log

Logging Options

Description

CGI_DEBUG check box

Enables logging of high-level information that is passed through the web server filter. This is helpful in determining password and user authentication problems.

CGI_SEND_DUMP check box

Enables logging of all incoming data that is passed through the web server filter.

CGI_RECEIVE_DUMP check box

Enables logging of all outgoing data that is passed through the web server filter.

FILTER_DEBUG check box

Enables logging of events that occur inside the web server filter.

PLUGIN_DEBUG check box

Enables logging of events that occur inside any web server plug-in filters that understand this flag.

The following buttons and other options are also available.

Other Options

Description

Update button

Saves any changes to the web filter configuration settings.

Reset button

Returns the web filter configuration settings to their last saved values.

A.1.5.2 WebUrlMaps Screen

Use the WebUrlMaps screen to add or edit URL mapping entries. It does the mapping inside Oracle WebLogic Server. To access this screen, select Administration, then click WebUrlMaps. This option is installed and enabled by default with Content Server deployment.

Element

Description

Text pane

Provides an overview and general information about the WebUrlMaps feature. Use the side scroll bar to view all the text.

Prefix field

The abbreviation that is used as a filter to evaluate whether a URL should be processed using a defined mapping script.

Map field

The script used to process applicable URLs and map them to the resulting URL.

Update button

Saves the changes made in the Prefix and Map fields.

Reset button

Reverts the values of the Prefix and Map fields to their previously saved settings. Any values entered but not saved are removed from the fields.

A.1.6 Provider Interface

The following screens are used when managing Content Server providers:

- Providers Page

- Provider Information Page

- Add/Edit Provider Page

- Outgoing Provider Page

- Database Provider Page

- Incoming Provider Page

- Preview Provider Page

- LDAP Provider Page

- keepaliveincoming Provider Page

- keepaliveoutgoing Provider Page

- sslincoming Provider Page

- ssloutgoing Provider Page

- JPS User Provider Page

- Outgoing Http Provider Page

A.1.6.1 Providers Page

The Providers page is used to find provider information, test providers, or add providers. To access this page, do one of the following:

- Click the Providers link from the Administration tray in the portal navigation bar.

- Click the View Providers link in the side navigation bar on the Admin Server Page.

Providers Table

Description

Provider column

Name of the provider that establishes connection to outside entities.

Description column

Description of the provider that establishes connection to outside entities.

Type column

The type of provider. This can include incoming, outgoing, database, preview, ldapuser, keepaliveincoming, keepaliveoutgoing, sslincoming, ssloutgoing, jpsuser, httpoutgoing, FileStore.

Connection State column

Possible states are:

- misconfigured

- good

- down

- requires restart

Last Activity Date column

The last date and time that the provider was active.

Action column

The Info link displays the Provider Information Page for the provider.
The Test link refreshes the Connection State and Last Activity Date columns for the provider.

New Provider Table

Description

Provider Type column

The type of provider.This can include:

- outgoing (see Outgoing Provider Page)

- database (see Database Provider Page)

- incoming (see Incoming Provider Page)

- preview (see Preview Provider Page)

- ldapuser (see LDAP Provider Page)

- keepaliveincoming (seekeepaliveincoming Provider Page)

- keepaliveoutgoing (see keepaliveoutgoing Provider Page)

- sslincoming (see sslincoming Provider Page)

- ssloutgoing (see ssloutgoing Provider Page)

- jpsuser (see JPS User Provider Page)

- httpoutgoing (see Outgoing Http Provider Page)

Description column

Description of the provider type.

Action column

Click the Add button to display the Add/Edit Provider Page for the provider type listed in the row.

A.1.6.2 Provider Information Page

The Provider Information page is used to review, edit, disable, or delete existing providers information. To access this page, click the Info link in the Action column for the row that corresponds to a provider on the Providers Page.

Note:
You can only edit, disable, or delete providers that you have created. You cannot edit, disable, or delete providers installed with the Content Server system.

Element

Description

Information fields

Displays information about the provider. The information shown depends on the type of provider and the content server configuration. See "Add/Edit Provider Page" for a description of each field.

Edit button

Displays the Add/Edit Provider Page for the provider. This button is not displayed for the default system providers.

Disable/Enable button

Disables or enables the provider. The content server must be restarted after a provider is disabled or enabled.
This button is not displayed for the default system providers.

Delete button

Deletes the provider. This button is not displayed for the default system providers.

A.1.6.3 Add/Edit Provider Page

The Add/Edit Provider page is used to create or edit a provider.

- To access the Add Provider page, click the Add link in the row for the type of provider you want to create on the Providers Page.

- To access the Edit Provider page, click Edit in the row for the provider type on the Provider Information Page.

The fields on the Add/Edit Provider page depend on the type of provider being created or edited:

- Outgoing Provider Page

- Database Provider Page

- Incoming Provider Page

- Preview Provider Page

- JPS User Provider Page

Other providers may be listed depending on your content server configuration.

A.1.6.4 Outgoing Provider Page

The Add/Edit Outgoing Provider page is used to create or edit an outgoing socket provider. To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.

Element

Description

Provider Name field

The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.

Provider Description field

User-friendly description of the provider.

Provider Class field

The name of the Java class for the provider. For example, intradoc.provider.SocketOutgoingProvider.

Connection Class field

The name of the Java class that implements the provider connection. For example, intradoc.provider.SocketOutgoingConnection.

Configuration Class field

The name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers.

Server Host Name field

The server host name (IDC_Name) of the other content server instance.

HTTP Server Address field

The HTTP address of the other content server instance. For example, intradoc:90.

Server Port field

The port on which the provider communicates with the other content server.

Instance Name field

The instance name of the other content server instance.

Relative Web Root field

The relative Web root of the other content server instance. For example, /_install_dir__instance_dir__2/.

Use Connection Password check box

If selected, Named Connections is used, and a connection name and password is required to access the target server.

Connection Password Name field

The name of the connection password.

Connection Password field

The connection password.

Client IP Filter field

The client IP addresses that are allowed to use the connection to the target server.

Handles Inbound Refinery Conversion Jobs check box

If selected, Inbound Refinery is used by this provider.

Inbound Refinery Read Only Mode check box

If selected, prevents Content Server from sending new conversion jobs to Inbound Refinery with this provider.

Add/Update button

Saves the provider information.

Reset button

Resets the provider information to the last saved values.

A.1.6.5 Database Provider Page

The Add/Edit Database Provider page is used to create or edit a database provider.

Note:
The SystemDatabase Provider uses the Oracle WebLogic Server data source, which in turn handles the actual database authentication and communication.

To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.

Element

Description

Provider Name field

The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.

Provider Description field

User-friendly description of the provider.

Provider Class field

The name of the Java class for the provider. For example, intradoc.jdbc.JdbcWorkspace.

Connection Class field

The name of the Java class that implements the provider connection. For example, intradoc.jdbc.JdbcConnection.

Configuration Class field

The name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers.

Database Type menu

The database type. Types include ORACLE, MSSQLSERVER, DB2, SYBASE.

JDBC Driver field

The JDBC driver name for the database type. When the database type is selected, an appropriate driver is automatically filled.

JDBC Connection String field

The JDBC connection string for the database type. When the database type is selected, an appropriate string is automatically filled.

Use Data Source check box

When selected, this specifies that the provider use a data source.

Data Source field

Specify the data source.

Test Query field

The test query will be used to test the provider when the Test link on the Providers page is clicked. When the database type is selected, a test query is automatically filled. You can choose to enter a different test query.

Database Directory field

The directory that contains the content server database information. For example, IntradocDir/database. Used only by DAO databases.

Database Name field

Used only by DAO databases.

JDBC User field

Your JdbcUser.

JDBC Password field

Your JdbcPassword.

Number of Connections field

The number of database connections the provider maintains. This is used only by JDBC databases.

Extra Storage Keys field

The extra storage keys required for the connection. A system storage key is automatically filled.

Additional Settings field

Any additional configuration settings for the database provider.

Add/Update button

Saves the provider information.

Reset button

Resets the provider information to the last saved values.

A.1.6.6 Incoming Provider Page

The Add/Edit Incoming Provider page is used to create or edit an incoming provider. To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.

Element

Description

Provider Name field

The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.

Provider Description field

User-friendly description of the provider.

Provider Class field

The name of the Java class for the provider. For example, intradoc.provider.SocketIncomingProvider.

Connection Class field

The name of the Java class that implements the provider connection. For example, intradoc.provider.SocketIncomingConnection.

Configuration Class field

The name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers.

Server Port field

The port the provider listens on for incoming connections. For example, the incoming system provider listens on port 4444 by default.

Add/Update button

Saves the provider information.

Reset button

Resets the provider information to the last saved values.

A.1.6.7 Preview Provider Page

The Add/Edit Preview Provider page is used to create or edit a preview provider. To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.

Element

Description

Provider Name field

The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.

Provider Description field

User-friendly description of the provider.

Provider Class field

The name of the Java class for the provider. For example, intradoc.provider.SocketOutgoingProvider.

Connection Class field

The name of the Java class that implements the provider connection. For example, intradoc.provider.SocketOutgoingConnection.

Configuration Class field

The name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers.

Server Host Name field

The server host name of the other content server instance. For example, localhost.

HTTP Server Address field

The HTTP address of the other content server instance. Use the value listed for HTTP Server on the Configuration Information page. For example, intradoc:90.

Server Port field

The port on which the provider communicates with Oracle Content Publisher. Typically, this is 4441.

Add/Update button

Saves the provider information.

Reset button

Resets the provider information to the last saved values.

A.1.6.8 LDAP Provider Page

The Add/Edit LDAP Provider page is used to create or edit an LDAP provider and configure Content Server integration with LDAP security. To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.

Note:
It is recommended that the JPS user provider be used with Oracle WebLogic Server. See JPS User Provider Page.

In the following tables, the term in parentheses in the first column is the corresponding configuration setting in the IntradocDir/data/providers/provider_name/provider.hda file.

Element

Description

Provider Name field

The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.

Provider Description field*

A user-friendly description of the provider.

Provider Class field*
(ProviderClass)

The name of the Java class that implements the provider.

- Default is intradoc.provider.LdapUserProvider.

Connection Class field
(ProviderConnection)

The name of the Java class that implements the connection to the LDAP server. Default is intradoc.provider.LdapConnection.

Configuration Class field
(ProviderConfig)

The name of a Java class that performs some extra configuration. This class is useful for database providers, where the connection classes are already providers.

Source Path field*
(SourcePath)

A unique string that identifies the LDAP provider. The first time a user requests credentials through the provider, this string is stored with the user information so it can be used to match the user with the provider next time the user asks for credentials. We suggest using the name of the provider as the Source Path.

LDAP Server field*
(LdapServer)

Host name of the LDAP server.

LDAP Suffix field*
(LdapSuffix)

The root suffix (naming context) to use for all LDAP operations (such as o=company.com or dc=company,dc=com). All mapping of LDAP groups to Content Server roles and accounts will begin at this root.
Do not include spaces before or after commas.

LDAP Port field*
(LdapPort)

The port the LDAP server listens on. The default is 389. If you are using SSL, you should set this to 636.

Number of connections field
(NumConnections)

The number of LDAP server connections the provider maintains.

Connection timeout field

The amount of time (in minutes) that a provider connection to the LDAP server is held open before the provider connection is closed and reopened.
For best results, set the amount of time to less than 15 minutes. If the amount of time is 15 minutes or greater, there could be a problem with the JNDI layer not holding the connection open.

Priority field
(Priority)

Specifies the order in which LDAP providers will be checked for the user credentials.

- This field is used only when a user has not previously logged into Content Server. If the user has previously requested credentials, the Source Path will be stored for that user, so the LDAP provider specified by the Source Path will be used.

- Each LDAP provider in a Content Server instance must have a unique Priority number.

Credential Map field

Specifies a credential map.

Using Netscape SDK check box
(UseNetscape)

There are two ways to connect to the LDAP server: using the Netscape SDK or using JNDI. This check box acts as a toggle between the two options.
Selected = Use Netscape SDK

Clear = Use JNDI

Use SSL check box
(UseSecureLdap)

If you select this check box, you must have the appropriate certificates installed on the LDAP server. When SSL is initiated, the certificates will secure communication between the LDAP server and the content server.
If you use a self-signed certificate for your LDAP server and select to use SSL, you may need to add the LDAP server's certificate to the JVM trusted certificate keystore to avoid a connection error with LDAP Port 636. The basic command for importing a certificate into the JVM keystore is the following:

%JAVA_HOME%\bin\keytool -import -file
server certificate file -alias server alias -keypass changeit -keystore
%JAVA_HOME%/jre/lib/security/cacerts

Use Group Filtering check box
(UseGroupFilter)

Selected: The Role Prefix and Account Prefix definitions will be used to select the LDAP groups that will be mapped to Content Server roles and accounts.
Clear: All LDAP groups will be mapped to Content Server roles and accounts. This is the default.

Use Full Group Names check box
(UseFullGroupName)

Selected: The entire hierarchy (up to the specified prefix or naming context) for an LDAP group will be included in the mapping to a Content Server role or account.
Clear: Only the lowest level unit of an LDAP group will be mapped to a Content Server role or account. This is the default.

Account Permissions Delimiter field
(AcctPermDelim)

The string that separates the account names from the account permissions in an LDAP group name.

- If an LDAP group name is mapped to an account and contains this substring, the string to the left of this substring will be the account name, and the string to the right of this substring will be the account permissions.

- For example, if the delimiter is defined as a + (plus sign), the group name Acct1+rw would map to an account named Acct1 with Read and Write permission. If the delimiter is defined as an _ (underscore), the Acct1+rw group name would map to an account named Acct1+rw, with RWDA permission by default.

- The default is _ (underscore).

- This field appears only if accounts are enabled in Content Server.

Default Network Roles field

The default role or roles assigned to a user who enters through this provider; for example, contributor.

Default Network Accounts field
(DefaultNetworkAccounts)

Defines the default account permissions for users who log in to Content Server with LDAP credentials.

- This must be a comma-delimited list of accounts. Do not include spaces before or after the commas that separate accounts.

- Permissions for each account can be specified in parentheses after the account name, such as account(RWDA). If no permissions are specified, RWDA permission is granted by default.

- The #none entry grants permission to documents that have no account assigned.

- The #all entry grants permissions to all accounts.

- The default is #none(RWDA).

- This setting does not apply to anonymous users.

- This setting defines the minimum account permissions. Account permissions defined by the external user base are added to these permissions. For example, if the default is #none(RW),Project(R), and a user's group maps to Project(RWD) permission, the user's permissions are #none(RW),Project(RWD).

- This field appears only if accounts are enabled in the Content Server.

Role Prefix field

The string that specifies where in the LDAP group name to start matching a Content Server role name.

Role Prefix Depth field

A number that specifies how many levels the LDAP group name can contain after the Role Prefix for the group name to be considered a valid role. Placing an asterisk (*) in the depth parameter for a specific prefix ensures that the short name for any group mapped through the prefix is used.

Role Prefix Add button

Adds the Role Prefix string and Depth as a clause in the Role Prefix box.

Role Prefix box
(RolePrefix)

Lists the Role Prefix clauses that will be used to select LDAP groups when the Group Filtering check box is selected. This box can be edited directly.
Do not include spaces before or after the commas that separate units in a prefix.

Account Prefix field

The string that specifies where in the LDAP group name to start matching a Content Server account name.
This field appears only if accounts are enabled in Content Server.

Account Prefix Depth field

A number that specifies how many levels the LDAP group name can contain after the Account Prefix for the group name to be considered a valid account.
This field appears only if accounts are enabled in the Content Server.

Placing an asterisk (*) in the depth parameter for a specific prefix ensures that the short name for any group mapped through the prefix is used.

Account Prefix Add button

Adds the Account Prefix string and Depth as a clause in the Account Prefix box.
This button appears only if accounts are enabled in Content Server.

Account Prefix box
(AcctPrefix)

Lists the Account Prefix clauses that will be used to select LDAP groups when the Group Filtering check box is selected. This box can be edited directly.
Do not include spaces before or after the commas that separate units in a prefix.

This box appears only if accounts are enabled in Content Server.

LDAP Attribute field

Enter an LDAP user attribute to be mapped to a Content Server user information field.

User Attribute field

Select a Content Server user information field to be mapped from the LDAP Attribute field.

- All Content Server user information fields for which you can change the value are listed.

- Standard user information fields begin with a "d".

- Custom user information fields begin with a "u".

User Attribute Add button

Adds the LDAP Attribute and User Attribute as a colon-separated clause in the Attribute Map box.

Attribute Map box
(AttributeMap)

Lists the Attribute Map clauses that will be used to map LDAP user attributes to Content Server information fields.

- This box can be edited directly.

- If this field is left blank, the default is:

mail:dEmail
cn:dFullName
title:dUserType

LDAP Admin DN field
(LdapAdminDN)

The user name that will be making calls to the LDAP server.

- This user must have Read rights to the LDAP server.

- If the user name is left blank, the provider will connect to the LDAP server anonymously.

Ldap Admin Password field
(LdapAdminPassword)

The password for the user that will be making calls to the LDAP server.

Add/Update button

Saves the provider information.

Reset button

Resets the provider information to the last saved values.

A.1.6.9 keepaliveincoming Provider Page

The Add Incoming Provider page for the keepalive function is used to create or modify a keepalive socket incoming provider. To access this page, select the Administration tray in the portal navigation bar, then select the Providers link to display the Providers Page. Click Add in the Action column for the keepaliveincoming provider type.

Element

Description

Provider Name field

(Required) Name of the provider.

Provider Description field

(Required) Description of the provider.

Provider Class field

(Required) Name of the Java class for the provider. For example: idc.provider.ExtendedSocketIncomingProvider

Connection Class field

Name of the Java class that implements the provider connection. For example: idc.provider.KeepaliveSocketIncomingConnection

Configuration Class field

Name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers.

Server Thread field

Name of the server thread for incoming connections. For example: idc.provider.KeepaliveIdcServerThread

Server Port field

(Required) Port the provider listens on for incoming connections. For example, the incoming system provider for Universal Content Management listens on port 4444 by default.

Add/Update button

Saves the provider information.

Reset button

Resets the provider information to the last saved valued.

A.1.6.10 keepaliveoutgoing Provider Page

The Add Outgoing Provider page for the keepalive function is used to create or modify a keepalive socket outgoing provider. To access this page, select the Administration tray in the portal navigation bar, then select the Providers link to display the Providers Page. Click Add in the Action column for the keepaliveoutgoing provider type.

These two images show the keepaliveoutgoing provider page.

Element

Description

Provider Name field

(Required) Name of the provider.

Provider Description field

(Required) Description of the provider.

Provider Class field

(Required) Name of the Java class for the provider. For example: idc.provider.KeepaliveSocketOutgoingProvider

Connection Class field

Name of the Java class that implements the provider connection. For example: idc.provider.KeepaliveSocketOutgoingConnection

Configuration Class field

Name of a Java class that performs some extra configuration.

Request Class field

Name of the Java class that implements the server request. For example: idc.provider.KeepaliveServerRequest

Number of Connections field

Maximum number of connections. For example, 3.

Server Host Name field

(Required) Server host name of the other content server instance. For example, localhost.

HTTP Server Address field

HTTP address of the other content server instance.

Server Port field

(Required) Port on which the provider communicates with the other content server.

Instance Name field

(Required) Name of the other content server instance.

Relative Web Root field

(Required) Relative web root of the other content server instance.

Proxied check box

Enable this option if the provider is connecting to a content server that will be controlled by the current instance.

Notify Target check box

Enable this option if the provider is connecting to a content server that is acting as a controlling instance, and you want this content server to notify the controlling instance when user information and/or content item information changes.

Users check box

Enable this option if you want this content server to notify the controlling instance when user information changes.

Released Documents check box

Enable this option if you want this content server to notify the controlling instance when content item information changes.

Enterprise Searchable check box

Enable this option if you have enabled Enterprise Search and you want this content server instance to be searchable.

Required Roles field

Enter roles that have permission to search this content server instance using Enterprise Search. If no roles are entered, all users will have permission.

Account Filter field

Enter accounts that have permission to search this content server instance using Enterprise Search. If no accounts are entered, all users will have permission.

Conversion options

Select the appropriate options if the provider uses Inbound Refinery.

Add button

Saves the provider information.

Reset button

Resets the provider information to the last saved values.

A.1.6.11 sslincoming Provider Page

The Add Incoming Provider page for the sslincoming function enables administrators to create an SSL socket incoming provider. To access the page, select the Administration tray in the portal navigation bar, then select the Providers link to display the Providers Page. Click Add in the Action column for the sslincoming provider type.

Element

Description

Provider Name field

(Required) Name of the provider.

Provider Description field

(Required) Description of the provider.

Provider Class field

(Required) Name of the Java class for the provider. For example: idc.provider.ssl.SSLSocketIncomingProvider

Connection Class field

Name of the Java class that implements the provider connection. For example: idc.provider.KeepaliveSocketIncomingConnection

Configuration Class field

Name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers

Server Thread field

Name of the server thread for incoming connections. For example: idc.provider.KeepaliveIdcServerThread

Server Port field

(Required) Port the provider listens on for incoming connections. For example, the incoming system provider listens on port 4444 by default.

Request Client Authentication check box

Enable this option if you want the provider to request client authentication from the incoming connection.

Require Client Authentication check box

Enable this option if you want the provider to require client authentication from the incoming connection.

Keystore/Alias/Truststore information

If necessary, enter the keystore password name, the alias, the alias password, and the truststore password.

Add button

Saves the provider information.

Reset button

Resets the provider information to the last saved values.

A.1.6.12 ssloutgoing Provider Page

The Add Outgoing Provider page for the ssloutgoing function enables administrators to create an SSL socket outgoing provider. To access the page, select the Administration tray in the portal navigation bar, then select the Providers link to display the Providers Page. Click Add in the Action column for the ssloutgoing provider type.

These two images show the ssloutgoing provider page.

Element

Description

Provider Name field

(Required) Name of the provider.

Provider Description field

(Required) Description of the provider

Provider Class field

(Required) Name of the Java class for the provider. For example: idc.provider.KeepaliveSocketOutgoingProvider

Connection Class field

Name of the Java class that implements the provider connection. For example: idc.provider.KeepaliveSocketOutgoingConnection

Configuration Class field

Name of a Java class that performs some extra configuration.

Request Class field

Name of the Java class that implements the server request. For example: idc.provider.KeepaliveServerRequest

Number of Connections field

Maximum number of connections. For example, 3.

Server Host Name field

(Required) Server host name of the other content server instance. For example, localhost.

HTTP Server Address field

HTTP address of the other content server instance.

Server Port field

(Required) Port on which the provider communicates with the other content server.

Instance Name field

(Required) Name of the other content server instance.

Relative Web Root field

(Required) Relative web root of the other content server instance.

Keystore/Alias/Truststore information

If necessary, enter the keystore password name, the alias, the alias password, and the truststore password.

Proxied check box

Enable this option if the provider is connecting to a content server that will be controlled by the current instance.

Notify Target check box

Enable this option if the provider is connecting to a content server that is acting as a controlling instance, and you want this content server to notify the controlling instance when user information and/or content item information changes.

Users check box

Enable this option if you want this content server to notify the controlling instance when user information changes.

Released Documents check box

Enable this option if you want this content server to notify the controlling instance when content item information changes.

Enterprise Searchable check box

Enable this option if you have enabled Enterprise Search and you want this content server instance to be searchable.

Required Roles field

Enter roles that have permission to search this content server instance using Enterprise Search. If no roles are entered, all users will have permission.

Account Filter field

Enter accounts that have permission to search this content server instance using Enterprise Search. If no accounts are entered, all users will have permission.

Conversion options

Select the appropriate options to have the provider use Inbound Refinery.

Add button

Saves the provider information.

Reset button

Resets the provider information to the last saved values.

A.1.6.13 JPS User Provider Page

The Add/Edit JPS User Provider page is used to create or edit a user provider which integrates with Oracle JPS. To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.

Element

Description

Provider Name field

The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.

Provider Description field

A user-friendly description of the provider.

Provider Class field

The name of the Java class that implements the provider.

Connection Class field

The name of the Java class that implements the connection to the LDAP server.

Configuration Class field

The name of a Java class that performs some extra configuration. This class is useful for database providers, where the connection classes are already providers.

Source Path field

A unique string that identifies the provider. The first time a user requests credentials through the provider, this string is stored with the user information so it can be used to match the user with the provider the next time the user asks for credentials. We suggest using the name of the provider as the Source Path.

JPS Context field

Host name of the Oracle JPS server.

JPS Attributes list

Select a JPS attribute to be mapped to a Content Server user information field.

User Attribute list

Select a Content Server user information field to be mapped from the JPS attributes field.

- All Content Server user information fields for which you can change the value are listed.

- Standard user information fields begin with a "d".

- Custom user information fields begin with a "u".

User Attribute Add button

Adds the JPS Attribute and User Attribute as a colon-separated clause in the Attribute Map box.

Attribute Map box

Lists the Attribute Map clauses that will be used to map user attributes to Content Server information fields.

- This box can be edited directly.

- If this field is left blank, the default is:

mail:dEmail
cn:dFullName
title:dUserType

Default Network Roles field

The default role or roles assigned to a user who enters through this provider. For example, contributor.

Add/Update button

Saves the provider information.

Reset button

Resets the provider information to the last saved values.

A.1.6.14 Outgoing Http Provider Page

The Add/Edit Outgoing Http Provider screen enables an administrator to add an httpoutgoing provider on the master content server. To access this page, select the Administration tray in the portal navigation bar, then click Providers. In the Create a New Provider pane, click Add in the Action column for the httpoutgoing provider.

Element

Description

Provider Name field*

The name of the provider.

Provider Description field*

A user-friendly description of the provider.

Provider Class field*

The name of the Java class for the provider. For example: proxyconnections.HttpOutgoingProvider

Connection Class field

The name of the Java class that implements the provider connection. For example: proxyconnections.HttpOutgoingConnection

Configuration Class field

The name of a Java class that performs some extra configuration. Leave this blank.

CGI URL field*

The URL for the proxy server.

Instance Name field*

The instance name of the proxy content server.

Relative Web Root field*

The relative web root of the content server instance.

Connection Password Name field

The name of a password connection (this can be an existing name or a name for a password connection that you will create on the proxy server). The name must specify one of the target master server's proxied connections. The target server requires a named password.

Connection Password field

The password for the named password connection.

Client IP Filter field

The client IP address or addresses that can use this connection to the target server.

Proxied check box

Enable this option if the provider is connecting to a remote server that will be controlled by this server.

Notify Target check box

Enable this option if the provider is connecting to a server that is acting as a controlling (master) server, and you want this server to notify the controlling server when user information or content item information changes.

Users check box

Enable this option to have this server to notify the controlling server when user information changes.

Released Documents check box

Enable this option to have the controlling server perform an enterprise search that includes this server.

Enterprise Searchable check box

Enable this option if you have enabled Enterprise Search and you want this content server instance to be searchable.

Required Roles field

Enter roles that have permission to search this content server instance using Enterprise Search. If no roles are entered, all users will have permission.

Account Filter field

Enter accounts that have permission to search this content server instance using Enterprise Search. If no accounts are entered, all users will have permission.

Handles Inbound Refinery Conversion Jobs check box

(Inbound Refinery only) Use this option only if the provider is an Inbound Refinery.

Inbound Refinery Read Only Mode check box

(Inbound Refinery only) Use this option to prevent the content server from sending new conversion jobs to this Inbound Refinery. This Inbound Refinery returns conversion jobs as the jobs are finished.

Conversion Options field

(Inbound Refinery only) Enter the number of jobs allowed in the pre-converted queue. The default is 100.

Add button

Saves the provider information.

Reset button

Resets the provider information to the last saved values.

A.1.7 Scheduled Jobs Administration Interface

The following screens are used in monitoring and managing scheduled jobs in Content Server.

- "Active Scheduled Jobs Screen"

- "Scheduled Jobs History"

- "Scheduled Jobs Information Screen"

A.1.7.1 Active Scheduled Jobs Screen

This screen enables administrators to view active jobs in Content Server and to modify their actions. To access this screen, select Administration from the portal navigation bar, then expand Scheduled Jobs Administration, then click Active Scheduled Jobs.

Element

Description

Job Name column

Name of the active job.

Job Description column

Describes the purprose of the active job.

Processed column

Date and time the job was processed or started processing.

Status column

Current status of a job. You can move your cursor over each icon to display a brief description of the status represented by the icon.

- High priority

- Inactive

- Repeat

- Short

Actions column

Use the Actions menu to implement the following actions on a job:

- Info

- Edit

- Cancel

- Delete

Use the Info icon to display the Job Information page.

A.1.7.2 Scheduled Jobs History

This screen enables administrators to view scheduled jobs history in Content Server. To access this screen, select Administration from the portal navigation bar, then expand Scheduled Jobs Administration, then click Scheduled Jobs History.

Element

Description

Job Name column

Name of the scheduled job.

Job Description column

Describes the purpose of a job.

Last Processed column

Date and time the job was last processed.

Last Status column

Last status of a job: Succeeded, Failed.

Actions column

Use the Info icon to display the Scheduled Jobs Information page.

A.1.7.3 Scheduled Jobs Information Screen

This screen enables administrators to view or edit information about a scheduled jobs in Content Server. To access this screen, select Administration from the portal navigation bar, then expand Scheduled Jobs Administration. Click either the Active Scheduled Jobs Screen or the Scheduled Jobs History and select the Info Icon to view jobs information. You can select Edit from the Actions menu on the Active Scheduled Jobs Screen to display a Scheduled Jobs Information screen that can be edited.

Element

Description

Name field

Name of the scheduled job. This can not be edited.

Description field

Description of the scheduled job.

Category field

Category of the scheduled job.

Exception Parent Job field

This field can not be edited. If there is no exception parent job, nothing is displayed.

Initial User field

Type of user that owns the scheduled job.

Queue Type field

Type of queue: short, or long.

Type field

Type of schedule: Immediate, Once, Repeat.

State field

Current state of the scheduled job.

Priority field

Priority number for the scheduled job.

Interval field

Interval specified for the scheduled job to be processed: one hour, two hours, one day, one week.

Start Token field

Token, if any, that triggers the schedule job to start processing.

Progress field

The progress of the scheduled job.

Create Date field

Date and time the scheduled job was created. This field can not be edited.

Update Date field

Date and time the scheduled job was updated. This field can not be edited.

Process Date field

Date and time the scheduled job was processed. This field can not be edited.

Last Processed Date field

Date and time the scheduled job was last processed. This field can not be edited.

Last Processed Status field

Status when the scheduled job was last processed. This field can not be edited.

Update button

Updates the screen settings with edited changes.

Reset button

Resets the screen settings to the original display.

A.1.8 Batch Interface Screens

The following screens are used in batch loading operations:

- Batch Loader Application

- BatchBuilder Screen

- BatchBuilder Mapping List Screen

- Add BatchBuilder Mapping Screen

- Edit BatchBuilder Mapping Screen

- Add/Edit BatchBuilder Mapping Field Screen

A.1.8.1 Batch Loader Application

The Batch Loader application is an administration application that is used to batch load files in the content server. To access this screen, follow the instructions for running administration applications in standalone mode.

Element

Description

Options menu

Save Configuration: Saves the current Batch Loader settings in the DomainHome/ucm/cs/bin/intradoc.cfg file.
Build Batch File: Displays the BatchBuilder Screen.

Exit: Closes the Batch Loader screen.

Help menu

Contents: Displays the content server online help.
About Content Server: Displays version, build, and copyright information for the content server.

Batch Load File field

The path and file name of the batch load file. If settings have not been saved to the intradoc.cfg file, the default is IntradocDir/samples/Batchloader/batchinsert.txt.

Browse button

Enables you to navigate to and select the batch load file.

Maximum errors allowed field

The number of errors after which the Batch Loader stops processing records from the batch load file. The default is 50.
If you plan to run the Batch Loader with a large number of files overnight, consider increasing this number so that the process does not stop prematurely.

If you are monitoring the Batch Loader closely, consider decreasing this number so you are notified of errors as they occur.

Clean up files after successful check in check box

Deletes each file from the hard drive after it is successfully checked in or updated.

Enable error file for failed revision classes check box

Creates a text file containing the file records that failed during batch loading. You can fix the errors in this content and rerun it as the batch load file.

Progress bar

Displays the progress of the batch loading process.

Load Batch File button

Starts the batch loading process.

A.1.8.2 BatchBuilder Screen

The BatchBuilder screen is used to create a batch load file. To access this screen, on the Batch Loader Application select the Options menu, then Build Batch File.

Element

Required?

Description

Options: Save Configuration

N/A

Saves the current BatchBuilder settings in the DomainHome/ucm/cs/bin/intradoc.cfg file.

Options: Load Batch Loader

N/A

Displays the Batch Loader Application.

Directory field

Yes

Enter the directory that contains the content to be included in the batch load file. All files in sub-directories of this directory will also be included in the batch load file.

Batch Load File field

Yes

Enter the path and file name of the batch load file to be created. If you enter the name of an existing file, the file will be replaced by the new batch load file.

Browse button

N/A

Enables you to navigate to and select the folder and enter a file name for the batch load file.

Mapping list

Yes

Select the mapping file to be used to specify metadata values.

Edit button

N/A

Displays the BatchBuilder Mapping List Screen.

File Filter field and Exclude Filter check box

No

Enter files to be included or excluded from the batch load file.
If this field is blank, all files in the specified directory and sub-directories are included.

If files are specified in this field and the Exclude Filter check box is clear, only the specified files are included in the batch load file.

If files are specified in this field and the Exclude Filter check box is selected, all files except the specified files are included in the batch load file.

Whole file names or file extensions can be specified.

Separate file names and extensions with a comma.

Extensions can be entered as *.ext, .ext, or ext.

Build button

N/A

Creates a batch load file using the specified parameters.

A.1.8.3 BatchBuilder Mapping List Screen

The BatchBuilder Mapping List screen is used to create a mapping list for the batch load file. To access this screen, on the BatchBuilder Screen click Edit next to the Mapping field.

Element

Description

Name column

Lists the available mapping files.

Description column

Short description of each mapping file.

Add button

Displays the Add BatchBuilder Mapping Screen.

Edit button

Displays the Edit BatchBuilder Mapping Screen.

Delete button

Deletes the selected mapping file.

Close button

Closes the BatchBuilder Mapping List screen.

A.1.8.4 Add BatchBuilder Mapping Screen

The Add BatchBuilder Mapping screen is used to name a new mapping file. To access this screen, on the BatchBuilder Mapping List Screen click Add.

Element

Description

Name field

Unique name for the mapping file. Maximum field length is 30 characters. The following are not acceptable: spaces, tabs, linefeeds, carriage returns, and ; ^ ? : @ & + " # % < * ~ |

Description field

Short description of the mapping file.

OK button

Displays the Edit BatchBuilder Mapping Screen.

Cancel button

Closes the Add BatchBuilder Mapping screen without creating a new mapping file.

A.1.8.5 Edit BatchBuilder Mapping Screen

The Edit BatchBuilder Mapping screen is used to edit a mapping file. To access this screen, do one of the following:

- Click OK on the Add BatchBuilder Mapping Screen.

- Click Edit on the BatchBuilder Mapping List Screen.

Element

Description

Description field

Short description of the mapping file.

Field column

Lists metadata fields that have values defined in the mapping file.

Value column

Shows the values that will be assigned to the metadata fields in the batch load file.

Add button

Displays the Add/Edit BatchBuilder Mapping Field Screen.

Edit button

Displays the Add/Edit BatchBuilder Mapping Field Screen.

Delete button

Deletes the selected metadata field from the mapping file.

OK button

Saves the current settings in the mapping file.

Cancel button

Closes the Edit BatchBuilder Mapping screen without applying any changes.

A.1.8.6 Add/Edit BatchBuilder Mapping Field Screen

The Add/Edit BatchBuilder Mapping Field screen is used to define the mapping value for a metadata field. To access this screen, click Add or Edit on the Edit BatchBuilder Mapping Screen.

Element

Description

Field field

Enter the name of the metadata field to be defined, such as dDocType or xComments.

Value

Enter the value to be used in the batch load file. You can type directly in this field or insert predefined variables from the column to the right.

<< button

Inserts the variable selected from the right column into the Value field.

Variable column

Lists predefined variables you can use as values in the batch load file.

OK button

Applies the field and value settings to the mapping file.

Cancel button

Closes the Add/Edit BatchBuilder Mapping Field screen without applying any changes.

A.1.9 Content Server Analyzer Interface

The following screens are used to confirm the integrity of the content server repository components, including the file system, database, and search index. It can also assist system administrators in repairing some problems that are detected in the repository components.

The Content Server Analyzer contains two tabs:

- Content Server Analyzer: Configuration Tab

- Content Server Analyzer: Progress Tab

The method to start the Content Server Analyzer depends on the operating system:

- (Windows) Select Start, then Programs, then Oracle Content Server, then instance_name, then Content Server Analyzer.

- (UNIX/Linux) Change to the DomainHome/ucm/cs/bin directory and run the Content Server Analyzer program.

A.1.9.1 Content Server Analyzer: Configuration Tab

The Configuration tab of the Content Server Analyzer Configuration table is used to configure analysis options and specify a customized logging directory structure:

Option

Description

Check database

Performs all checks on the database, ensures the integrity of the database columns, and confirms the consistency of data between the DocMeta, Revision, and Documents tables.

Check RevClassIDs

Ensures the accurate data synchronization between the dRevClassID and dDocName tables.

Clean database

Removes inconsistent rows from the database. Extra entries in the DocMeta table are deleted, inadequately defined entries in the Document table are deleted, and entries without a corresponding reference in the Revisions table are deleted.

Check search index

Analyzes the search index to ensure its integrity and checks for duplicate data records for indexed documents and any documents that might be missing from the search collection.

Clean search index

Re-indexes the search index and replaces missing data records of any omitted documents.

Check file system

Analyzes the file system (weblayout and vault file repositories) to ensure all necessary files are present.

Delete

Permanently deletes extra files that were found during the file system analysis.

Safe delete

Creates a safe delete directory in the logs/ directory and copies the extra files that were found during the file system analysis into this directory.

Check for extra files

Identifies any possible extra files that might be in the file system.

Generate report

Uses the console window to report statistics about the content items in the repository. It includes information pertaining to the status, release and processing states of content items in the file system and provides prior and current totals. Progress and error messages are also logged to the console window.

Range

Specifies the first and last of the criteria analyze.

Log Directory

The default directory used by Content Server Analyzer is DomainHome/ucm/cs/bin/logs/. Optionally, you can also enter a custom directory name. If the Safe delete option is selected, the files are moved to this directory.

A.1.9.2 Content Server Analyzer: Progress Tab

The Progress tab of the Content Server Analyzer displays the progress of the analysis processes and all generated information. To access this tab, click the tab on the Content Server Analyzer Application, or click Start Analysis on the Content Server Analyzer Application.

Element

Description

Task progress bar

Displays the combined progress of the specific analysis tasks selected on the Configuration tab.

Overall progress bar

Displays the overall progress of the analysis process.

Console area

Area that displays the information collected and summarized during the analysis processes. Displays applicable information for each selected option. Also displays progress and error messages generated during the analysis processes.

Start Analysis button

Starts the content server analysis.

A.1.10 Error and Status Information Interface

This section includes user interface illustrations and reference descriptions for error and status information.

- "Content Server Logs Screen"

- "Archiver Log Screen"

- "Database Log Screen"

- "Configuration Information Page"

- "Environment Packager Page"

A.1.10.1 Content Server Logs Screen

Content Server log files are listed by date and time. One file is generated for each day. Entries are added to the file throughout the day as events occur. To access this screen, select Administration then Log Files from the portal navigation bar, then select Content Server Logs. To access a specific log file, click a log date and time link on the page.

Element

Description

Type column

Displays the type of log file entry:

- Info: Displays basic status information.

- Error: Displays errors that occur but do not stop the software from functioning.

- Fatal: Displays errors that stop the software from functioning.

Time column

Displays the date and time of the log file entry.

Description column

Displays information about the log file entry. The level of detail depends on the type of entry.

A.1.10.2 Archiver Log Screen

Archiver log files show information about imports, exports, and replications. The log files are listed by date and time. One file is generated for each day. Entries are added to the file throughout the day as events occur To access this screen, select Administration then Log Files from the portal navigation bar, then select Archiver Logs.

Element

Description

Type column

Displays the type of log file entry:

- Info: Displays basic status information.

- Error: Displays errors that occur but do not stop the software from functioning.

- Fatal: Displays errors that stop the software from functioning.

Time column

Displays the date and time of the log file entry.

Description column

Displays information about the log file entry. The level of detail depends on the type of entry.

A.1.10.3 Database Log Screen

Database log files are listed by date and time. One file is generated for each day. Entries are added to the file throughout the day as events occur. To access this screen, select Administration from the portal navigation bar, then Log Files, then Database Logs. To access a specific log file, click a log date and time link on the page.

Element

Description

Type column

Displays the type of log file entry:

- Info: Displays basic status information.

- Error: Displays errors that occur but do not stop the software from functioning.

- Fatal: Displays errors that stop the software from functioning.

Time column

Displays the date and time of the log file entry.

Description column

Displays information about the log file entry. For more information, click Details.

A.1.10.4 Configuration Information Page

The Configuration Information Page provides configuration details for a Content Server instance. To access this page, click Administration in the portal navigation bar, then click Configuration for [Instance].

Element

Description

Server Name

Name of the Content Server. For more information, click Server Configurations.

Version

Release and build numbers for the Content Server software.

ClassLoader

Type of Classloader. For more information, click Show Classpath Details.

Install Directory

Path of the install directory for the Content Server instance. For more information, click Directory Details.

Database Type

Name of the type of database configured for use by the Content Server. For more information, click Database Connection Details.

Database Version

Version number and type for the database configured for use by the Content Server.

HTTP Server Address

Address for the HTTP server for the Content Server. For more information, click Internet Configurations.

Mail Server

Specific name for the Content Server mail server (router.companyname.suffix).

Search Engine

Name of the search engine configured for use with the Content Server.

Index Engine Name

Name of the index engine configured for use with the Content Server.

Active Index

Name of the active index.

Number of Installed Features

Number of features installed on the Content Server. For more information, click Feature Details.

Number of Enabled Components

Number of components installed and enabled on the Content Server. For more information, click Enabled Component Details.

Number of Disabled Components

Number of components disabled on the Content Server. For more information, click Disabled Component Details.

Auto Number Prefix

Automatically generated prefix number. For more information, click Server Options.

Use Accounts

If using accounts on the Content Server, set to True. If not using accounts, set to False.

Ntlm Security Enabled

If Ntlm security is enabled, set to True. If Ntlm security is disabled, set to False.

Allow get copy for user with read privilege

If users with Read privilege can get a copy of a content item, then set to True. If users with Read privilege can not get a copy of a content item, then set to False. For more information, click Content Security Details.

Allow only original contribute to check out

If only the original contributor (user) can check out a content item, then set to True. If users besides the original contributor can check out a content item, then set to False.

Java Version

Number of the software version of Java used with the Content Server. For more information, click Java Properties.

A.1.10.5 System Audit Information Page

The System Audit Information page provides audit details for a Content Server instance. To access this page, click Administration in the portal navigation bar, then click System Audit Information.

Element

Description

General Information area

Provides the following information:

- Amount of time the Content Server has been up and running.

- Number of service requests processed, and whether the system is handling services requests successfully.

- Total JVM memory capacity, and total JVM available memory. For more information, click Memory Details.

- Total number of threads. For more information, click Thread Details.

- Total number of active database connections. For more information, click Database Connection Details.

- Total number of audit messages.

Localization Information area

Provides the following information:

- Number for the string key count.

- Whether the localization system is using string index.

- Number for the localization test run time.

- Number for localization test lookups per second.

Tracing Sections Information area

Provides the following information and options:

- Full Verbose Tracing check box. Select to implement full verbose tracing.

- Save check box. Select to save the tracing information.

- Active Sections field, in which to specify the active sections to trace.

- Event Trap Text field, in which to specify what text to trap in the trace.

- Add Thread Dump check box. Select to add a thread dump to the trace.

- Update button to capture the selections made in this area.

- Reset button to clear the selections made in this area.

Cache Information area

Provides the following information:

- Number of permanently loaded pages and resource files.

- Number at which cache is temporarily capped.

- Whether any temporary items are loaded.

- Total number of distinct search queries being executed. For more information, click Search Cache Details.

- Total number of items in cache.

- Total number of items stored in schema cache.

- Number of bytes used out of number permitted.

- Buffer Cache Summary. For more information, click Buffer Pool Details.

Configuration Entry Information area

Provides the following information:

- Number of environment keys.

- Number of overwritten config values.

- Number of ignored settings.

- Number of removed settings.

Component Report area

Lists server components by name. For details, click the name of a component. Details include a component's location, version number, and status.

A.1.10.6 Environment Packager Page

The Environment Packager is a diagnostic tool that creates a zip file of the desired state directories, log files, and other component and resource directories. To access this page, click Administration on the portal navigation bar, then click Environment Packager.

Element

Description

Unix 'etc' Log Directory check box

Select this box to include Unix 'etc' log directory information in the zip file.

Server Data State Directory check box

Select this box to include the server data State directory information in the zip file.

Search Engine State Directory check box

Select this box to include the search engine State directory information in the zip file.

Schema Resources Directory check box

Select this box to include the schedule resources directory information in the zip file.

Content Server Logs check box

Select this box to include Content Server log information in the zip file.

Archiver Logs check box

Select this box to include Archiver log information in the zip file.

Verity Logs check box

Select this box to include Verity log information in the zip file.

Database Logs check box

Select this box to include database log information in the zip file.

Custom Components Directory check boxes

Select All Files to include the custom component directory in the zip file. Select Digests Only to include just the digests for the custom component directory in the zip file.

Classes Directory check boxes

Select All Files to include all Classes directory files in the zip file. Select Digests Only to include just the digests for the classes directory in the zip file.

Weblayout Common Directory for Applets check boxes

Select All Files to include all weblayout common directory for applets files in the zip file. Select Digests Only to include just the digests for the weblayout common directory for apples files in the zip file.

Layout and Skin Web Resources check boxes

Select All Files to include Layout and Skin Web resources in the zip file. Select Digests Only to include just the digests for layout and skin Web resources in the zip file.

wwResourcesDir check boxes

Select All Files to include wwResourcesDir in the zip file. Select Digests Only to include just the digests for wwResourcesDir in the zip file.

Start Packaging button

Starts the environment packaging process for the selected items.

Reset button

Resets the selected items to their default settings.

A.2 Security and User Access Interface

This section includes user interface illustrations and reference descriptions for managing security and user access.

- "Security Administration Interface"

- "Groups, Roles, and Permissions Interface"

- "Accounts Interface"

- "User Login and Alias Interface"

- "Proxy Connections Interface"

A.2.1 Security Administration Interface

The following are the main screens used when managing security:

- User Admin Screen

- Define Filter Screen

- Show Columns Screen

A.2.1.1 User Admin Screen

The User Admin application is an administration application used to set up and manage users, security groups, and accounts. You can run this application by accessing it using the browser interface or in standalone mode.

To access this screen, click Administration, then Admin Applets, then User Admin.

If you run the User Admin application by accessing it in standalone mode, it might cause ADSI authenticated users to lose their credentials.

Element

Description

Options menu

Tracing: Opens the Tracing Configuration screen, from which you can perform features related to system-wide tracing.
Exit: Closes the User Admin application.

Security menu

Displays options to set:
Permissions by Group: Displays the Permissions By Group Screen.

Permissions by Role: Displays the Permissions By Role Screen.

Predefined Accounts: Displays the Predefined Accounts Screen. This option is available only if accounts are enabled.

Apps menu

Used to open other administration applications. The other applications open in the same mode (applet or standalone) as the current application.

Help menu

Contents: Displays the Content Server online help.
About Content Server: Displays version, build, and copyright information for the Content Server.

Users tab

Used to add, edit, and delete user logins. See the User Admin Screen: Users Tab.

Aliases tab

Used to add, edit, and delete user aliases. See the User Admin Screen: Aliases Tab.

Information Fields tab

Used to add, edit, and delete user information fields. See the User Admin Screen: Information Fields Tab.

A.2.1.2 Define Filter Screen

The Define Filter screen is used to narrow the list of information that is displayed on several administration application screens. The Define Filter screen displays a series of fields that are applicable to the administration application screen. Check the box next to the field to activate that field as a filter.

This screen can be accessed from a variety of other administration screens. For example, a Define Filter button is displayed on the Users tab part of the User Admin screen.

Element

Description

Check boxes

Select one or more check boxes to activate the filter fields.

Fields

The Users list on the original screen will be filtered based on the criteria entered. The following wildcards can be used in these fields:

- With MS Access or MSDE:
* = one or more characters

? = single character

- With all other databases:
% = one or more characters

_ = single character

User Name field

The user login.

Full Name field

The full name that corresponds to the user login.

User Type field

An attribute defined by the system administrator as a way to classify users.

Auth Type field

User authorization type, either Local, Global or External.

E-Mail Address field

The e-mail address associated with the user. This is used for workflow and subscription notifications.

User Locale field

The user's locale, which specifies the language of the user interface and date/time format.

Organization field

The user's Organization Path value, which can be defined by the system administrator as a way of classifying global users.

Source field

The LDAP user provider used to retrieve user information. Also, this field specifies if the user came from an NTLM or ADSI integration with the value: MSN.

Custom fields

Any custom user information fields will be available as filter fields.

A.2.1.3 Show Columns Screen

The Show Columns screen is used to specify the columns that are displayed on several administration application screens. The Show Columns screen displays a series of fields that are applicable to the administration application screens. Check the box next to a field to have that field displayed as a column in the administration screens.

This screen can be accessed from a variety of other administration screens. For example, a Show Columns button is displayed on the Users tab part of the User Admin screen.

Element

Description

Check boxes

Selected: The field is displayed in the Users list on the original screen.
Clear: The field is not displayed on the Users list.

See the Define Filter Screen for field descriptions.

Save Settings check box

Selected: The column settings are applied every time the original screen is displayed.
Clear: The column settings apply only until the original screen is closed.0

A.2.2 Groups, Roles, and Permissions Interface

The following screens are used when creating groups and roles and establishing permissions:

- Permissions By Group Screen

- Add New Group Screen

- Permissions By Role Screen

- Add New Role Screen

- Edit Permissions Screen

A.2.2.1 Permissions By Group Screen

The Permissions By Group screen is used to add security groups, delete security groups, and edit permissions associated with existing security groups. To access this screen, select Security, and then Permissions by Group in the User Admin Screen.

Caution:
Security Group names cannot contain square brackets. This is due to limitations in the search engine technology.

Element

Description

Groups list

Lists existing security groups

Roles list

Lists the roles associated with existing security groups.

Edit Permissions button

Enables you to edit permissions for the security group.

Add Group button

Displays the Add New Group Screen.

Delete Group button

Enables you to delete an existing security group. (You will not be able to delete a security group if content still exists in that security group.)

A.2.2.2 Add New Group Screen

The Add New Group screen is used to define the name and description for a new security group. To access this screen, click Add Group on the Permissions By Group Screen.

Element

Description

Group Name field

- The Group Name is limited to 30 characters.

- The following characters are not allowed: spaces, tabs, linefeeds, returns, and ; : ^ ? & + " # % < * ~ |

- Uppercase accented letters are not allowed; lowercase accented letters are acceptable. (For example, Älvdalsån will not work, but älvdalsån will.)

Description field

A brief description of the security group.

- The Description is limited to 80 characters.

- This field is displayed only in the User Admin Screen.

A.2.2.3 Permissions By Role Screen

The Permissions By Role screen is used to add roles, delete roles, and edit rights and permissions associated with roles. To access this screen, click Security then Permissions by Role from the main menu on the User Admin Screen.

Element

Description

Roles list

Lists existing roles.

Groups/Rights list

Lists the security groups and the rights associated with the selected role.

Edit Permissions button

Enables you to edit permissions for a security group and role. This button is available when you select a role and a group/right.

Edit Applet Rights button

Enables you to edit rights for the role. This button is available when you select a role.

Add New Role button

Displays the Add New Role Screen, on which you can set up a new role for users. Add the role name, and click OK.

Delete Role button

Enables you to delete the selected role. (You will not be able to delete a role if any users are assigned to that role.)

A.2.2.4 Add New Role Screen

The Add New Role screen is used to define the name of a new role. To access this screen, click Add New Role on the Permissions By Role Screen.

Element

Description

Role Name field

- The Role Name is limited to 30 characters.

- The following characters are not allowed: spaces, tabs, linefeeds, returns, and ; : ^ ? & + " # % < * ~ |

- Initially, a role is assigned Read (R) permission to the Public security group and no permissions to any other security groups.

A.2.2.5 Edit Permissions Screen

The Edit Permission screen is used to change permissions to a specific security group for a specific role. To access this screen, do one of the following:

- In the Permissions By Group Screen, select a security group, select a role, and click Edit Permissions.

- In the Permissions By Role Screen, select a role, select a security group, and click Edit Permissions.

Element

Description

Read check box

Allows users to view files.

Write check box

Allows users to view, check in, check out, and obtain a copy of files.

Delete check box

Allows users to view, check in, check out, get a copy, and delete files.

Admin check box

Allows users to view, check in, check out, get a copy, and delete files, and check in files for other users. In addition, if the user has Workflow rights, they can start or edit a workflow.

A.2.3 Accounts Interface

The following screens are used when adding accounts.

- Predefined Accounts Screen

- Add New Predefined Account Screen

- Add/Edit Account Permissions Screen

A.2.3.1 Predefined Accounts Screen

The Predefined Accounts screen is used to add and delete predefined accounts. This screen is available only when Accounts are enabled on the system. To access this screen, select Security, and then Predefined Accounts in the User Admin Screen.

Element

Description

Predefined Accounts list

Shows the predefined accounts.

Add button

Displays the Enabling Accounts.

Delete button

Deletes the selected account.
You can delete an account even if content with that account still exists. The account value will remain assigned to the content item, but will be considered a user-defined account.

A.2.3.2 Add New Predefined Account Screen

The Add New Predefined Account screen is used to name a new predefined account. To access this screen, click Add on the Predefined Accounts Screen.

Element

Description

Predefined Account field

Enter the name of the account to be added. Keep the names short and consistent. For example, set up all of your accounts with a three-letter abbreviation by location or department (MSP, NYC, and so no). Account names can be no longer than 30 characters, and the following are not acceptable: spaces, tabs, linefeeds, carriage returns, and the symbols: ; ^ ? : & + " # % < > * ~.

A.2.3.3 Add/Edit Account Permissions Screen

The Add New Account screen/Edit Permissions for Account Screen is used to assign account permissions to users. To access this screen, click Add or Edit on the Add/Edit User Screen: Accounts Tab.

Element

Description

Account list

Select a predefined account from the list, or enter a user-defined account.

Permissions check boxes

Set the Predefined Permissions
that the user will have to the account.

A.2.4 User Login and Alias Interface

The following screens are used when creating and editing user logins and aliases.

- User Admin Screen: Users Tab

- Choose/Change the Authorization Type Screen

- Add/Edit User Screen

- Add/Edit User Screen: Info Tab (Local User)

- Add/Edit User Screen: Info Tab (Global User)

- Add/Edit User Screen: Roles Tab

- Add Role Screen

- Add/Edit User Screen: Accounts Tab

- Option List Screen

- User Admin Screen: Aliases Tab

- Add New Alias/Edit Alias Screen

- Select Users Screen

- Sub-Administration Interface: Edit Rights Screen

- User Admin Screen: Information Fields Tab

- Add Metadata Field Name Screen

- Edit Metadata Field Screen

- Update Database Design Screen

A.2.4.1 User Admin Screen: Users Tab

The Users tab of the User Admin screen is used to add, edit, and delete user logins. To access this tab, display the User Admin Screen.

Element

Description

Use Filter check box

Select this check box to narrow the Users list as defined by the Define Filter Screen.

Define Filter button

Displays the Define Filter Screen.

Show Columns button

Displays the Show Columns Screen.

Users list

Shows the users that match the filter settings. Double-clicking a user displays the Add/Edit User Screen for that user.

Add button

Displays the Choose/Change the Authorization Type Screen.

Add Similar button

If you highlight a user and click Add Similar, the system displays the Add/Edit User Screen with some fields already populated.

Edit button

Displays the Add/Edit User Screen for the selected user.

Change button

Displays the Choose/Change the Authorization Type Screen for the selected user.

Delete button

Enables you to delete a user login.

A.2.4.2 Choose/Change the Authorization Type Screen

The Choose/Change the Authorization Type screen is used to specify the user authorization type when adding a new user or changing the authorization type for a selected user. To access this screen, either click Add on the User Admin Screen: Users Tab or select a user name in the User Admin screen Users tab and then click Change.

External users are created automatically when they are granted content server access using an external user repository. User passwords for external users granted content server access must be initially set by the administrator.

Element

Description

Authorization Type list

The type of user.
Local: Users defined by an administrator or sub-administrator within the Content Server system. Administrators assign these users one or more roles, which provide the user with access to security groups. Undefined users are assigned the guest role.

Global: Lightly-managed users. Both local and global user credentials can extend to multiple content servers.

OK button

Displays the Add/Edit User Screen: Info Tab (Local User) or the Add/Edit User Screen: Info Tab (Global User), depending on which Authorization Type is selected.

A.2.4.3 Add/Edit User Screen

The Add/Edit User screen is used to define user information, assign roles, and assign account permissions for a user. To access this screen, do one of the following:

- On the User Admin Screen: Users Tab, click Add.

- Select a user authorization type and click OK on the Choose/Change the Authorization Type Screen. The Add User screen is displayed.

- Select a user and click Edit on the User Admin Screen: Users Tab. The Edit User screen is displayed.

The information that appears on this screen may be different than that on your system if custom metadata fields have been added. The fields shown in this screen shot are the defaults installed with Content Server.

The tabs visible on this screen depend on which type of user is selected and whether accounts are enabled:

- Add/Edit User Screen: Info Tab (Local User)

- Add/Edit User Screen: Info Tab (Global User)

- Add/Edit User Screen: Roles Tab

- Add/Edit User Screen: Accounts Tab

A.2.4.4 Add/Edit User Screen: Info Tab (Local User)

The Info tab of the Add/Edit User screen is used to add a user. To access this tab for a local user, do one of the following:

- Select Local and click OK on the Choose/Change the Authorization Type Screen.

- Select a local user and click Edit on the User Admin Screen: Users Tab.

Element

Description

Name field

The name of the new user.

- This field has a 50-character limit.

- User names are case-sensitive.

Full Name field

The entire name of the new user. This field has a 50-character limit.

Password field

The password for the new user login.

- This field has a 50-character limit.

- Passwords are case-sensitive.

Confirm Password field

Reenter the password from the previous field to confirm the spelling.

E-mail Address field

The e-mail address associated with the user. This is used for workflow and subscription notifications.

User Type list

Select a user type from the list of attributes which can be defined by the system administrator as a way to classify users.

List button

Displays the Option List Screen.

User Locale field

The user's locale, which specifies the language of the user interface and date/time format. Locale options must be enabled by the system administrator.
If you change the user locale for a user who has the sysmanager role, you must restart the Admin Server service for the Admin Server interface to appear in the user's locale language.

User Time Zone field

Select a user time zone from the menu.

A.2.4.5 Add/Edit User Screen: Info Tab (Global User)

The Info tab of the Add/Edit User screen is used to add a user. To access this tab for a global user, do one of the following:

- Select Global and click OK on the Choose/Change the Authorization Type Screen.

- Select a global user and click Edit on the User Admin Screen: Users Tab.

Element

Description

Name field

The name of the new user. This field has a 50-character limit.

Organization Path list

A list that can be defined by the system administrator as a way of classifying users.

List button

Displays the Option List Screen.

Password field

The password for the new user login. This field has a 50-character limit.

Confirm Password field

Reenter the password from the previous field to confirm the spelling. The same limit applies.

Full Name field

The entire name of the new user. This field has a 50-character limit.

E-mail Address field

The e-mail address associated with the user. This is used for workflows and subscriptions.

User Type field

A list of attributes that can be defined by the system administrator as a way to classify users.

User Locale field

The user's locale, which specifies the language of the user interface and date/time format. Locale options must be enabled by the system administrator.
If you change the user locale for a user who has the sysmanager role, you must restart the Admin Server service for the Admin Server interface to appear in the user's locale language.

User Time Zone field

Select a user time zone from the menu.

Override check boxes

These settings apply only if the user is changed from a global user to an external user, or if user information is automatically assigned by a custom plug-in to the content server.
Selected: The user information assigned in the Add/Edit User screen overrides any externally assigned user information (such as user attributes from an LDAP server).

Clear: The user information assigned in the content server is overridden by any externally assigned user information.

A.2.4.6 Add/Edit User Screen: Roles Tab

The Roles tab of the Add/Edit User screen is used to assign roles to a user. To access this tab, click Roles on the Add/Edit User Screen.

Element

Description

Roles list

These roles are displayed in the Roles field.

Groups/Rights list

Lists the security group permissions associated with the selected role.

Add Role button

Displays the Add Role Screen, on which you can select a role from a drop-down list.

Remove Role button

Removes the selected role from the user login.

A.2.4.7 Add Role Screen

The Add Role screen is used to assign a role to a user. To access this screen, click Add Role on the Add/Edit User Screen: Roles Tab.

Element

Description

Role Name field

Select a role from the list to assign to the user.

A.2.4.8 Add/Edit User Screen: Accounts Tab

The Accounts tab of the Add/Edit User screen is used to assign accounts to a user. To access this tab, click Accounts on the Add/Edit User Screen.

This tab is available only if accounts are enabled.

Element

Description

Accounts list

Lists the accounts that are assigned to this user login. By default, all new users are assigned Read, Write, Delete, and Admin permission to documents that are not in an account.

Add button

Displays the Add/Edit Account Permissions Screen.

Edit button

Displays the Accounts Case Study.

Delete button

Enables you to delete a new account.

Default Account list

Select the account that will be entered as the default value on the Content Check In Form page for this user. All accounts for which the user has at least RW permission are listed.

A.2.4.9 Option List Screen

The Option List screen is used to create a list of options that can be used to group users. This screen can be accessed from a variety of interface locations. For grouping users, this screen is accessed by using the User Type menu on the Add/Edit User Screen: Info Tab (Local User) and Add/Edit User Screen: Info Tab (Global User).

These option lists do not have any security functionality in the content server; they are simply a means by which you can group users.

Element

Description

Option list

Enter the values that can be selected for the User Type or Organization Path. Each value must be on a separate line, with a carriage return between values.

Ascending option

Sorts the list in alphabetical order.

Descending option

Sorts the list in reverse alphabetical order.

Ignore Case check box

Selected: Sorts the list in alphabetical order, regardless of case.
Clear: Values that start with uppercase letters are grouped separately from values that start with lowercase letters.

Sort Now button

Sorts the list in the manner specified by the Ascending, Descending, and Ignore Case options.

A.2.4.10 User Admin Screen: Aliases Tab

The Aliases tab of the User Admin screen is used to add, edit, and delete aliases. To access this tab, display the User Admin Screen, and click Aliases.

Element

Description

Name column

Lists the alias names.

Description column

Description of each alias.

Add button

Displays the Add New Alias/Edit Alias Screen.

Edit button

Displays the Add New Alias/Edit Alias Screen.

Delete button

Enables you to delete the selected alias.

A.2.4.11 Add New Alias/Edit Alias Screen

The Add New Alias/Edit Alias screen is used to add, edit, and delete user logins for an alias. To access this screen, click Add or Edit on the User Admin Screen: Aliases Tab.

Element

Description

Alias Name field

The alias name is limited to 30 characters. The following are not allowed: spaces, tabs, line feeds, returns and ; : ^ ? @ & + " # % < * ~ |

Alias Display Name field

Name of the alias that appears on a display.

Description field

Maximum 80 characters.

Users list

Lists the user logins that are included in the alias.

Add button

Displays the Select Users Screen.

Delete button

Deletes the selected user login from the alias.

A.2.4.12 Select Users Screen

The Select Users screen is used to add user logins to an alias. To access this screen, click Add on the Add New Alias/Edit Alias Screen.

Element

Description

Use Filter check box

Select this check box to narrow the Users list as defined by the Choose/Change the Authorization Type Screen.

Define Filter button

Displays the Choose/Change the Authorization Type Screen.

Show Columns button

Displays the Show Columns Screen.

Users list

Shows the users that match the filter settings. See the Choose/Change the Authorization Type Screen for column descriptions.

A.2.4.13 Sub-Administration Interface: Edit Rights Screen

The Edit Rights screen is used to assign sub-administration rights to a role. To access this screen, select a role and click Edit Applet Rights on the Permissions By Role Screen.

Element

Description

Rights.Apps.UserAdmin check box

Assigns sub-administration rights to the User Admin application.

Rights.Apps.WebLayout check box

Assigns sub-administration rights to the Web Layout Editor application.

Rights.Apps.RepMan check box

Assigns sub-administration rights to the Repository Manager application.

Rights.Apps.Workflow check box

Assigns sub-administration rights to the Workflow Admin application.

A.2.4.14 User Admin Screen: Information Fields Tab

The Information Fields tab of the User Admin screen is used to add, edit, and delete user information fields. To access this tab, display the User Admin Screen and click Information Fields.

- When a field is added in the Information Fields tab, it is also added to the user information on the Users tab.

- You do not need to rebuild the search index after adding new user fields.

Element

Description

Up button

Moves the selected user information field up in the list.

Down button

Moves the selected user information field down in the list.

Name column

The name of the user information field.

Is Custom column

No: Indicates a system (predefined) user information field. Yes: Indicates a custom user information field.

Type column

The type of field:
Text: 30 characters.

Long Text: 100 characters.

Date: Date format (such as dd/mm/yyyy or dd/mm/yy for the English-US locale).

Memo: 255 characters.

Integer: -231 to 2 31 (-2 billion to +2 billion). By definition, an integer is a natural number, so decimal values and commas are not permitted.

Caption column

The field label that appears on content server pages.

Is Option List column

False: The user information field does not have an option list.
True: The user information field has an option list.

Add button

Displays the Add Metadata Field Name Screen, on which you can add a new field name.

Edit button

Displays the Edit Metadata Field Screen.

Delete button

Deletes the selected custom user information field. (System user information fields cannot be deleted.)

Update Database Design button

Displays the Update Database Design Screen.

A.2.4.15 Add Metadata Field Name Screen

The Add Metadata Field screen is used to define the name of a custom user information field. To access this screen, click Add on the User Admin Screen: Information Fields Tab.

Element

Description

Field Name field

Duplicate names are not allowed. Maximum field length is 29 characters. The following are not acceptable: spaces, tabs, line feeds, carriage returns and ; ^ ? : @ & + " # % < * ~ |
When you add a custom user information field, the system automatically prefixes the name with a "u" to ensure that it is unique and does not conflict with any reserved names. However, you must be careful not to inadvertently use restricted names for columns in the user logins table because they may conflict with reserved names in databases.

For example, if you try to use "ID" to name a new custom user information field, the result will be "UID" when the system adds the prefix. This causes an error because UID is a reserved database name.

Similarly, when you define a custom metadata field, the system automatically prefixes the name with an "x" to ensure that it is unique and does not conflict with any reserved names.

OK button

Displays the Edit Metadata Field Screen.

A.2.4.16 Edit Metadata Field Screen

The Edit Metadata Field screen is used to define a user information field. To access this screen, do one of the following:

- Enter a field name and click OK on the Add Metadata Field Name Screen

- Select a user information field and click Edit on the User Admin Screen: Information Fields Tab.

Element

Description

Field Caption field

Label for the field that is displayed on content server pages.

Field Type

Text: 30 characters.
Long Text: 100 characters.

Date: Date format (such as dd/mm/yyyy or dd/mm/yy for the English-US locale).

Memo: 255 characters.

Integer: -2^31 to 2^31 (-2 billion to +2 billion). By definition, an integer is a natural number, so decimal values and commas are not permitted.

Override Bit Flag

For internal use.

Administrator Only Edit check box

Selected: The field is not displayed on the User Profile pages. However, the field is visible to an admin user through the User Admin applet.
Clear: The field is displayed on the User Profile page.

View Only Field check box

Selected: The field is displayed on the User Profile page, but cannot be edited by the user.
Clear: If the Administrator Only Edit check box is clear, the field can be edited by the user on the User Profile page.

Enable Option List check box

If selected, the field has an option list that is defined by the Option List Type and Option List Key. Values shown in the Information Fields tab Is Option List are True or False.

A.2.4.17 Update Database Design Screen

The Update Database Design screen is used to add or delete user information fields in the content server database. To access this screen, add or delete a user information field and click Update Database Design on the Edit Metadata Field Screen.

Element

Description

Info field(s) that will be added

Lists the user information fields that were added since the last time the database was updated.

Info field(s) to delete check boxes

Lists the user information fields that were deleted since the last time the database was updated.
Selected: The user information field is deleted from the database.

Clear: The user information field is not deleted from the database. The field remains hidden on the User Admin screen and User Profile pages, but it still exists in the database.

A.2.5 Proxy Connections Interface

The following screens are used when creating proxied connections:

- Credential Maps Screen

- Proxied Connection Authentication/Authorization Information Screen

A.2.5.1 Credential Maps Screen

The Credential Maps enables administrators to create credentials for specific users that can be mapped to allow users controlled access between a master content server and a proxy content server. To access the page select Administration in the portal navigation bar, then select Credential Maps.

Element

Description

Map Identifier field

Enter the unique identifier for the credentials map.

Values field

Enter the credential values in two columns with a comma used as a separator between the columns, and a carriage return between rows. The first column specifies input values. The second column specifies output values.

Update button

Inputs the credential values specified in the Credential Maps page.

A.2.5.2 Proxied Connection Authentication/Authorization Information Screen

This screen enables administrators to create named passwords, which are passwords that are assigned to specific proxied connections by name. To access the page, select the Administration tray in the portal navigation bar, then select Connection Passwords.

Element

Description

Proxied Connection Name field

Name given to the proxied connection.

Description field

Brief description of the proxied connection.

Password field

Password assigned to the proxied connection.

Confirm Password field

Password assigned to the proxied connection.

IP Address Filter field

IP address number of the client content server.

HTTP IP Filter field

HTTP IP address filter, applied to the IP address of the client content server.

Update button

Updates the page with any modified information.

A.3 Components Interface

This section provides information about the interface used with Content Server components and server features. It contains the following topics:

- "Component List Screen"

- "Component Wizard Main Screen"

- "Component Creation Screens"

- "Build Screens"

- "Advanced Component Manager Page"

- "Component Manager Page"

To display the Component Wizard:

- (Windows) From the Start menu, click Programs, then Content Server, then instance_name, then Tools, then Component Wizard.

- (UNIX/Linux) Change to the DomainHome/ucm/cs/bin/ directory and run the ComponentWizard program.

The Component List Screen and the Component Wizard Main Screen are displayed.

A.3.1 Component List Screen

The Component List appears when you first access the Component Wizard. It lists all currently installed components. To access this screen, either start the Component Wizard or select Open from Options in the Component Wizard Main Screen.

Element

Function

Enable Tag Filtering check box

Enables tag filtering for custom components.

Update Filter button

Updates the filter used for tag filtering.

Inclusion Tag Filter menu

Provides a menu of available inclusion tag filters.

Exclusion Tag Filter menu

Provides a menu of available exclusion tag filters.

Custom Components list

Shows the name, status (enabled or disabled), location, and types of the component definition file for each component that has been installed in the Content Server.

Add button

Displays the Add Component Screen.

Open button

Opens the selected component in the Component Wizard.

Install button

Displays the Install Screen.

Uninstall button

Removes the selected component from the Content Server. (The component files remain in the file system, but the component no longer appears on the list of components.)

Enable button

Enables the selected component.

Disable button

Disables the selected component.

Help button

Displays a help page for the Component List screen.

A.3.2 Component Wizard Main Screen

The Component Wizard main screen is used to manage Content Server components.

Element

Description

Options Menu

Provides options for working with components and settings.

Build Menu

Used to package component files into a Zip file.

Help Menu

Provides links to online documentation.

Summary fields

Show the name of the component, the location and file name of the component definition file, and the status of the component (enabled or disabled).

Launch Editor button (top right)

Displays the component definition file ("glue" file) in the default text editor.

Resource Definition tab

Lists the custom resource definitions that have been defined for the component. When a specific custom resource definition is selected, the tab is extended to display custom HTML includes and custom data includes for the definition.

Custom Resource Definition list

Lists the custom resource definitions that have been defined for the component. Each definition is listed by type and file name.

Add button
(Custom Resource Definition tab)

Displays the Add Resource screen, which is used to add a new resource file to the component.

Remove button

Removes the selected resource from the component.

Launch Editor button
(Resource Definition tab)

Displays the selected resource file in the default text editor.

Reload button

Reloads the component definition file for the selected resource.

Custom resources pane

Lists the custom parameters for the resource selected in the Custom Resource Definition list. This pane is different for each type of resource and can display HTML Includes, Data Includes, custom strings, custom environment parameters, and able names. Custom resources can be added, edited, or deleted.

Java Code tab

Displays any custom Java code that has been defined for the component.

Install/Uninstall Settings tab

Displays custom installation parameters, including whether the component has an install or uninstall filter, whether the component has preference resources, and preference prompts setup. Settings can be added, edited, or deleted.

A.3.2.1 Options Menu

The Options menu provides options for working with components and settings.

Menu Item

Description

Add

Displays the Add Component Screen.

Open

Displays the Component List Screen.

Close

Closes the open component.

Install

Displays the Install Screen.

Enable

Enables the component that is open in the Component Wizard.

Disable

Disables the component that is open in the Component Wizard.

Configure

Displays the Component Configuration Screen.

Edit Readme File

Displays the readme.txt file for the open component in the default text editor. If a readme.txt file does not exist for the component, a blank readme.txt file is created.

Set HTML Editor

Displays the HTML Editor Configuration screen, which is used to enter an HTML editor path.

Exit

Closes the Component Wizard.

A.3.2.2 Build Menu

The Build menu is used to package component files into a zip file.

Menu Item

Description

Build Settings

Displays the Build Settings screen, which is used to specify the settings used to build a component Zip file.

Build

Displays the Build screen, which is used to build a component Zip file.

A.3.2.3 Help Menu

This screen provides links to online documentation.

Menu Item

Description

Contents

Displays the online help for system administrators.

About Content Server

Displays version, build, and copyright information for the Content Server.

A.3.3 Component Creation Screens

The following screens are used to build custom components:

- Add Component Screen

- Install Screen

- Component Configuration Screen

- Add/Edit Action Screen

- Add Screen

- Add Query Table Information Screen

- Add Service Table Information Screen

- Add Dynamic Resource Table Information Screen

- Add Static Resource Table Information Screen

- Predefined Dynamic Tables

- Add Template Table Information Screen

- Add/Edit HTML Resource Include/String Screen

- Add/Edit Parameter Screen

- Add/Edit Query Screen

- Add Resource Screen

- Resource Selection Dialog Screen

- Add/Edit Service Screen

- Preview Information for Service Screen

- Preview Action Information Screen

- Add/Edit SearchResults Template Screen

- Column Information Screen

- Add/Edit Intradoc Template Screen

- Add/Edit Preference Screen

A.3.3.1 Add Component Screen

The Add Component screen is used to add a new component to the Content Server. To access this screen, either select Add from Options in Component Wizard Main Screen or click Add on the Component List Screen.

Element

Function

Create New Component option

Select this option to create a custom component in the Content Server.

Name field

Assign a descriptive component name. The name cannot contain spaces.

Directory field

Enter the directory where the component definition file will be located, relative to Content Server install directory. Typically, custom components are located in the custom directory.

Copy Existing check box

Selected = The new component will be a copy of an existing component, including all resources and other component files. Enter the path and file name of an existing component definition file (.hda). The new component must have a unique name.
Clear = The new component will be created without any resource files.

Browse button

Used to navigate to and select an existing component definition file.

Use Existing Component option

Select this option to add an existing component to the Content Server.

File Path field

The path and file name of the existing component.

Browse button

Used to navigate to and select an existing component definition file.

OK button

Adds the component to the Content Server.

Cancel button

Closes the screen without adding a component.

Help button

Displays a help page for the Add Component screen.

A.3.3.2 Install Screen

The Install screen is used to install a component zip file on the Content Server. To access this screen, either select Install from Options in Component Wizard Main Screen or click Install on the Component List Screen.

Element

Description

Select button

Used to navigate to and select the Zip file to be unpackaged.

Entry Type column

Lists the items that are included in the component Zip file.

Current Root Prefix column

The root directory where the related component files will be installed.

Location column

The subdirectory or the file name of the component file.

OK button

Unpackages the component onto the Content Server.

Cancel button

Closes the screen without unpackaging the component.

Help button

Displays a help page for the Unpackage screen.

A.3.3.3 Component Configuration Screen

The Component Configuration screen is used to specify which program to use to edit component files from within the Component Wizard. To access this screen, select Configure from Options in Component Wizard application.

Specify a text editor (such as WordPad) rather than a graphical HTML editor (such as FrontPage). Graphical editors can insert or change HTML tags and might cause Idoc Script tags to be converted into a string of characters that are not recognized by the Content Server.

Element

Description

HTML Editor Path field

The path and file name of the executable file for the editing program. For example, c:/Program Files/Windows NT/accessories/wordpad.exe.

Browse button

Used to navigate to and select the file.

OK button

Sets the specified file as the editing program.

Cancel button

Closes the screen without changing the editing program.

Help button

Displays a help page for the Component Configuration screen.

A.3.3.4 Add/Edit Action Screen

The Add/Edit Action screen is used to specify the actions that are associated with a newly defined component service.

Element

Description

Type list

Select the type of action. See the Predefined Action Types.

Action list

Select an action from the list or enter a custom action. The option list shows the predefined actions that are associated with the option selected from the Type list.

Parameters field

If the action takes parameters, enter the parameters as a comma-delimited list.

- For the Select Query and Select Cache Query action types, the first parameter is the name that the action assigns to the ResultSet returned from the query. This ResultSet can then be referenced in the template page.

- For the Load Option List action type, the parameters are optional. However, if parameters are given, the first parameter is the key under which the option list is loaded, and the second parameter is the selected value for display on an HTML page.

Control Mask check boxes

The control mask controls the results of queries to the database.

Error Message field

Enter the error message to be displayed by this action. This action error message overrides the error message provided as an attribute of the service.

- If the action error message is not empty, it becomes the active error message.

- If the action error message is empty, the error message remains unchanged from the previous action.

OK button

Saves the action in the Actions list on the Add/Edit Service screen.

Cancel button

Closes the Add/Edit Action screen without creating a service action.

Help button

Displays this help page for the Add/Edit Action screen.

A.3.3.4.1 Predefined Action Types

The following action types can be specified for a service:

- Select Query: This action type is used to select a query and then discard it immediately.

- Execute Query: This action type is used to execute a query.

- Java Method: This action type is used to apply a method that is part of the Java class implementing the service. The following Java Method actions can be selected from the Action list:

Note:
See the query.htm, workflow.htm, and indexer.htm files in the IdcHomeDir/resources/core/tables directory for more information on predefined queries.

Name

Description

checkSecurity

This method is used for validating security for actions on a particular document, such as check in, check out, and delete. It checks the logged in user's security group and account permissions against the service's access level for performing the specified action.
Takes zero or one parameter, which is the name of a ResultSet.

createResultSetSQL

This method executes a query with parameters taken from the Data Binder (dataSource and whereClause local data) rather than from given parameters. It also places the results in the local data using the ResultSet name found in the Data Binder (resultName).
Takes no parameters.

doSubService

This method executes a subservice.
Takes one parameter, which is the name of a subservice.

loadDefaultInfo

This method is used for creating checkin and update pages. It first executes the loadDefaultInfo filter, and then loads environment information, content types, formats, and accounts.
Takes no parameters.

loadMetaOptionsLists

This method first executes the loadMetaOptionsLists filter, and the loads all options lists referred to in the DocMetaDefinition table.
Takes no parameters.

loadSharedTable

This method is used to make a server-cached table available for a template. Use this method instead of executing a query when the data is already cached in the server.
Takes two parameters. The first parameter is the name of the table to look up in the server's cached tables. The second is the name the table is given when it is added to the data.

loadSharedTableRow

This method is used to retrieve cached information, such as data about a specific user. The value for the key in the request data is used to find the row in the cached table. The values of the row are mapped to the local data using the names of the columns as keys.
Takes two parameters. The first parameter is the name of the table to look up in the server's cached tables. The second parameter is an argument specifying a column in the database and a lookup key into the request data.

mapResultSet

This method is used to replace a Type 5 action when the service requires only a part of the first row of a ResultSet to be stored. It executes the specified query and maps the specified columns of the first row of the ResultSet to the local data.
Takes at least three parameters. The first parameter is the name of a select query; the parameters that follow must appear in comma-delimited pairs. The first member of the pair is the column name, and the second member is the key that is used to put the row value into local data.

refreshCache

This method performs a refresh on the specified Subjects.
Takes one or more parameters, as a comma-delimited list of subjects.

renameValues

This method assigns the value from one variable to another variable.
Takes one or more sets of parameters that must appear in comma-delimited pairs. The first member of a pair is the variable name that is looked up in the Data Binder, and the second member is the variable name that stores the found value in the local data.

setConditionVars

This method sets condition variables to true (1) or false (0). These values can be tested only in HTM template pages. They are not put into local data.
Takes one or more sets of parameters that must appear in comma-delimited pairs. The first member of a pair is the name of the condition variable, and the second member is the value (1 or 0).

setLocalValues

This method places name/value pairs into the local data.
Takes one or more sets of parameters that must appear in comma-delimited pairs. The first member of a pair is the variable name, and the second member is the value.

- Load Option List: This action type is used to load an option list stored in the system.

- Select Cache Query: This action type is used to select a query and then cache the query results.

A.3.3.5 Add Screen

The Add Screen is used during the build process to specify what should be included in the component zip file.

Element

Description

Entry Type list

Select the type of item to be included in the component Zip file. Each entry type has a default location (Current Root Prefix) that cannot be changed. The Component Class option ensures that the components and related files are placed in the 'component' directory.
If your component must work with earlier versions of Content Server (pre-7.0), the following Entry Type options are not compatible: Component Class, Component Library, Bin, Data, Weblayout, and Resources.

Current Root Prefix field

Shows the directory where the specified files are copied when the component Zip file is unpackaged.

Sub Directory or File field

Enter the subdirectory that contains the component files of the selected type, or enter an individual file name. If an individual file is contained in a subdirectory of the current root prefix, enter the subdirectory along with the file name. For example, new_custom/new_component.htm.

Make Jar check box

Selected = A Jar file is created and included in the manifest file. Selecting this option enables the Include Java Source option.
Clear = A Jar file is not created.

Include Java Source check box

Selected = Source files are included which allows the Java source code to be shipped with the component. This option is only available if the Make Jar check box is selected.
Clear = Source files are not included.

OK button

Adds the specified item to the component Zip file list.

Cancel button

Closes the Add screen without adding an item to the component Zip file list.

Help button

Displays this help page for the Add screen.

A.3.3.6 Add Query Table Information Screen

The Add Query Table Information screen is used to specify the database table to be used with a component's query.

Element

Description

Table Name field

Enter the name of the query table that is created for the new resource. The default is the name of the component followed by an underscore and the string Queries.

Back button

Displays the Add Resource screen.

Next button

Displays the Add Query screen.

Finish button

Creates the new query resource. This button is unavailable if the minimum specifications have not been defined for the resource.

Cancel button

Closes the Add Query Table Information screen without creating a new resource.

Help button

Displays this help page for the Add Query Table Information screen.

A.3.3.7 Add Service Table Information Screen

The Add Service Table Information screen is used to specify the database to be used by the service in the component.

Element

Description

Table Name field

Enter the name of the service table that is created for the new resource. The default is the name of the component followed by an underscore and the string Services.

Back button

Displays the Add Resource screen.

Next button

Displays the Add Service screen.

Finish button

Creates the new service resource. This button is unavailable if the minimum specifications have not been defined for the resource.

Cancel button

Closes the Add Service Table Information screen without creating a new resource.

Help button

Displays this help page for the Add Service Table Information screen.

A.3.3.8 Add Dynamic Resource Table Information Screen

The Add Dynamic Resource Table Information screen is used to create dynamic tables to be used in a custom component.

Element

Description

Table Name field

Enter the name of the dynamic table that is created for the new resource. The default is the name of the component followed by an underscore.

Merge To check box and field

Used to create a merge rule for the new dynamic table. Select this check box and either select the target table from the list of Predefined Dynamic Tables or enter the name of a custom table.

Back button

Displays the Add Resource screen.

Next button

Inactive (there are no more screens for defining a dynamic resource table).

Finish button

Displays the Column Information screen. This button is unavailable if the minimum specifications have not been defined for the resource.

Cancel button

Closes the Add Dynamic Resource Table Information screen without creating a new resource.

Help button

Displays this help page for the Add Dynamic Resource Table Information screen.

A.3.3.8.1 Predefined Dynamic Tables

The following dynamic resource table is predefined in the Content Server:

Table Name

mergeColumns

Description

IgnoredFlexFields

templatename, flexareaname, fields

Used to exclude any custom metadata fields from specific template pages. Wildcards are supported for both the templatename and flexareaname columns.

A.3.3.9 Add Static Resource Table Information Screen

The Add Static Resource Table Information screen is used to specify a static resource in your component.

Element

Description

Table Name field

Enter the name of the static table that is created for the new resource. The default is the name of the component followed by an underscore.

Merge To check box and field

Creates a merge rule for the new static table. Select this check box and either select the target table from the list of Predefined Static Tables or enter the name of a custom table.

Back button

Displays the Add Resource screen.

Next button

Inactive (there are no more screens for defining a static resource table).

Finish button

Displays the Column Information screen. This button is unavailable if the minimum specifications have not been defined for the resource.

Cancel button

Closes the Add Static Resource Table Information screen.

Help button

Displays this help page for the Add Static Resource Table Information screen.

A.3.3.9.1 Predefined Static Tables

The following static resource tables are predefined in the content server:

Table Name

mergeColumns

Table Location (in IdcHomeDir/resources/ core/tables/)

Description

ColumnTranslation

column, alias

/resources/upper_clmns_map.htm

Contains uppercase database fields with their translated field names. This table is required for databases that use all uppercase (such as Oracle).

DataSources

name, dataSource, useMaxRows

/resources/std_resources.htm

Contains the queries that are executed to create reports in the Web Layout Editor.

IntradocReports

name, datasource, filename, description

/reports/reports.hda

Contains the list of report templates.

IdocScriptExtensions

name, class, loadOrder

/resources/std_resources.htm

Contains specializations of the ScriptExtensionsAdaptor. Used to create new Idoc Script functions and variables.

ServiceHandlers

serviceName, handler, searchOrder

/resources/std_resources.htm

Contains specializations of the ServiceHandler base class. Defines Java methods for handling service script Java functions.

SubscriptionTypes

type, fields, description

/resources/std_resources.htm

Contains document subscription types. Default subscription is by document name. Document criteria subscriptions can be defined in this table.

UserMetaDefinition

umdName, umdType, umdCaption, umdIsOptionList, umdOptionListType, umdOptionListKey, umdIsAdminEdit, umdOverrideBitFlag

/resources/std_resources.htm

Contains the definitions of the auxiliary user metadata fields. Values for umdOverrideBitFlag should start at 16 (0x10) or higher. See the design of the DocMetaDefinition database table for a description of the appropriate contents of these fields.

A.3.3.10 Add Template Table Information Screen

The Add Template Table Information screen is used to specify the table that will be accessed for the template used in the component.

Element

Description

Table Name field

Enter the name of the template table that is created for the new resource. The default is the name of the component followed by an underscore.

Merge Table list

Creates a merge rule for the new dynamic table. Select a target table from the list of Predefined Template Tables.

Back button

Displays the Add Resource screen.

Next button

Depending on which Merge Table is selected, displays the Add Intradoc Template screen or Add SearchResults Template screen.

Finish button

Creates the new template resource. This button is unavailable if the minimum specifications have not been defined for the resource.

Cancel button

Closes the Add Template Table Information screen without creating a new resource.

Help button

Displays this help page for the Add Template Table Information screen.

A.3.3.10.1 Predefined Template Tables

The following template tables are predefined in the Content Server:

Table Name

mergeColumns

Description

IntradocTemplates

name, class, formtype, filename, description

This is a ResultSet table that defines the templates used in the Content Server.

SearchResultTemplates

name, formtype, filename, outfilename, flexdata, description

This table is used to create result templates in memory for use with results that are returned from the search engine.

A.3.3.11 Add/Edit HTML Resource Include/String Screen

The Add/Edit HTML Resource Include/String screen is used to specify a customized HTML resource or a customized string resource in a component.

Element

Description

Resource type options

Include = The resource defines an HTML include.
String = The resource defines a locale-sensitive string.

Name field

Enter the name of the include or string that is created, or click Select to start with a predefined include.
For string names, use the following prefix conventions:

syStringName: System-level messages and errors.

csStringName: Content Server messages and log messages (this is the most common type of string).

wwStringName: Strings used on Web pages.

apStringName: Strings used in applets.

Select button

Displays the Resource Selection Dialog screen, which lists the predefined includes. This button is available only when the Include option is selected.

Code field

Shows the code for the include or string, which can be edited directly in this field. If a predefined include is selected, the code is automatically added to this field.

Back button

Displays the Add Resource screen.

Next button

Inactive (there are no more screens for defining an include or string).

Finish button/OK button

Saves the include or string resource and asks to open the text file for editing.

Cancel button

Closes the Add/Edit HTML Resource Include/String screen without saving the include or string.

Help button

Displays this help page for the Add/Edit HTML Resource Include/String screen.

A.3.3.12 Add/Edit Parameter Screen

The Add/Edit Parameter screen is used to define the parameters that will be passed to your defined resources.

Element

Description

Name field

Enter a name for the parameter. A parameter name cannot contain spaces.

Type field

Select the type of parameter:

OK button

Saves the parameter in the query.

Cancel button

Closes the Add/Edit Parameter screen without creating or changing the parameter.

Help button

Displays this help page for the Add/Edit Parameter screen.

A.3.3.13 Add/Edit Query Screen

The Add/Edit Query screen is used to specify the SQL query for the query resource defined in the component.

Element

Description

Name field

Enter the name of the query that is created for the resource, or click Select to start with a predefined query.

Select button

Displays the Resource Selection Dialog screen, which lists the predefined queries. See the query.htm, workflow.htm, and indexer.htm files in the IdcHomeDir/resources/core/tables directory for more information on predefined queries.

Query field

Shows the SQL query expression, which can be edited directly in this field. If an existing query is selected, the query expression is automatically added to this field.

Parameters list

Lists the name and type for each parameter defined for the query. Parameters must be listed in the order they appear in the query expression.

Up and Down buttons

Move the selected parameter up or down in the Parameters list.

Add button

Displays the Add Parameter screen.

Edit button

Displays the Edit Parameter screen for the selected parameter.

Delete button

Deletes the selected parameter from the Parameters list.

Back button

Displays the Add Query Table Information screen.

Next button

Inactive (there are no more screens for defining a query).

Finish button/OK button

Saves the query in the query resource. The Finish button is unavailable if the minimum specifications have not been defined for the resource.

Cancel button

Closes the Add/Edit Query screen without creating or changing the query resource.

Help button

Displays this help page for the Add/Edit Query screen.

A.3.3.14 Add Resource Screen

The Add Resource screen is used to select the type of resource you will use in your component. It is used to select a variety of resources.

Element

Description

Resource Type options

Select an option from the Resource Type list.

File Name field

Select or enter the path and file name for the new resource.

Load Order field

Enter a load order number for the resource. Lower values are loaded first. Resources that have the same load order number are loaded in the order they appear in the component definition ("glue") file.

Back button

Displays the previous page of the resource definition screens (if any).

Next button

Displays the next page of the resource definition screens (if any).

Finish button

Creates the new resource. This button is unavailable if the minimum specifications have not been defined for the resource.

Cancel button

Closes the Add Resource screen without creating a new resource.

Help button

Displays this help page for the Add Resource screen.

A.3.3.15 Resource Selection Dialog Screen

The Resource Selection Dialog screen is used to select an existing resource for use or to edit for your component.

Element

Description

Show All check box

Selected = All predefined items are displayed.
Clear = The most commonly used predefined items are displayed.

Name column

Lists the predefined items.

Description column

Describes each predefined item.

OK button

Selects the selected option and fills in fields on the associated "Add" screen.

Cancel button

Closes the Resource Selection Dialog screen without selecting a resource item.

Help button

Displays this help page for the Resource Selection Dialog screen.

A.3.3.16 Add/Edit Service Screen

The Add/Edit Service screen is used to enter the information for the service being created by the component.

Element

Description

Name field

Enter the name of the service that is created, or click Select to start with a predefined service.

Select button

Displays the Resource Selection Dialog screen, which lists the predefined services.

Service Class field

Select a service class from the list or enter a name for a custom service class. The service class determines what actions can be performed by the service. There are actions that all services share, while other actions are specific to the service class.

Template field

Select a template to present the results of service. If the results of the service do not require page presentation, leave this field blank. For example, the PageHandlerService, which is called from an applet, does not specify a template page.

Service Type field

If the service is to be executed inside another service, select SubService.

Access Level check boxes

Select one or more check boxes to assign a user access level to the service.

Subjects Notified field

Enter the Subjects (subsystems) to be notified by the service as a comma-delimited string. If a service changes one or more subjects, it must notify the affected subjects of changes. For example, the ADD_USER service adds a new user to the system and informs the system that the userlist subject has changed.

Error Message field

Enter the error message to be displayed by this service. This error message is returned by the service if no action error message overrides it.
The error message can be a plain text string, or it can be a parameter to be looked up in the Content Server language strings (for example, !csUnableToBuildCheckInForm).

Actions list

Lists the name and type for each action defined for the service. Actions are used to execute an SQL statement, perform a query, run code, cache the results of a query, or load an option list. The order of the list specifies the order in which the actions are performed.

Up and Down buttons

Move the selected action up or down in the Actions list.

Add button

Displays the Add Action screen.

Edit button

Displays the Edit Action screen for the action selected in the Actions list.

Delete button

Deletes the selected action from the Actions list.

Back button

Displays the Add Service Table Information screen.

Next button

Inactive (there are no more screens for defining a service).

Finish button/OK button

Saves the service in the service resource. The Finish button is unavailable if the minimum specifications have not been defined for the resource.

Cancel button

Closes the Add/Edit Service screen without creating or changing the service.

Help button

Displays this help page for the Add/Edit Service screen.

A.3.3.16.1 Subjects

Subjects are subsystems within the Content Server. When a service makes a change (such as add, edit, or delete) to one of the following subjects, the subject must be notified:

- accounts

- aliases

- collections

- docformats

- doctypes

- documents

- dynamicqueries

- indexerwork

- metadata

- metaoptlists

- subscriptiontypes

- templates

- userlist

- usermetaoptlists

- wfscripts

- wftemplates

- workflows

A.3.3.17 Preview Information for Service Screen

The Preview Information for Service screen is used to view details about a service before selecting it for use as a service resource. To access this screen, highlight a service on the Add/Edit Service Screen and click Preview.

To view details about the actions used in the service, highlight an action and click Preview. The Preview Action Information Screen is displayed.

When you finish viewing service information, click Close.

For complete information about services and actions, see the Oracle Fusion Middleware Services Reference Guide for Universal Content Management.

A.3.3.18 Preview Action Information Screen

The Preview Action Information screen is used to view the details of service actions. To access this screen, highlight an action on the Preview Information for Service Screen and click Preview. When done viewing action details, click Close.

For complete information about services and actions, see the Oracle Fusion Middleware Services Reference Guide for Universal Content Management.

A.3.3.19 Add/Edit SearchResults Template Screen

The Add/Edit SearchResults Template screen is used to find a template to use for your component.

Element

Description

Name field

Enter the name of the template that is created for the resource, or click Select to start with a predefined template.

Select button

Displays the Resource Selection Dialog screen, which lists the predefined StandardResults template.

Copy From check box and field

Selected = The new template resource will be a copy of an existing template. Enter the complete path and file name of the existing template file (.htm).
Clear = A new template resource file is created.

Browse button

Used to navigate to and select the desired template file.

View button

Displays the template file in a read-only text window.

Form Type field

Select the template form type, which is the specific type of functionality the page is trying to achieve.

File name field

The file name of the template resource. This can be either an absolute path or a relative path, relative to the location of the component_template.hda resource file.

Out File Name field

For future use. Leave this field blank.

Flex Data field

Defines the metadata to be displayed for each row on the search results page.

Description field

Enter a description of the template file.

Back button

Displays the Add Template Table Information screen.

Next button

Inactive (there are no more screens for defining a template).

Finish button/OK button

Saves the template file in the template resource. The Finish button is unavailable if the minimum specifications have not been defined for the resource.

Cancel button

Closes the Add/Edit SearchResults Template screen without creating or changing the template resource.

Help button

Displays this help page for the Add/Edit SearchResults Template screen.

A.3.3.20 Column Information Screen

The Column Information screen appears only when you create a new table. To edit the table, you must open the file in a text editor.

Element

Description

Column Name field

Enter a column name to be added to the bottom of the Columns list.

Insert button

Adds the Column Name entry to the bottom of the Columns list.

Delete button

Deletes the column selected in the Columns list.

Columns list

Lists the columns that are defined for the table.

OK button

Saves the column list.

Cancel button

Closes the Column Information screen without saving the column list.

Help button

Displays this help page for the Column Information screen.

A.3.3.21 Add/Edit Intradoc Template Screen

The Add/Edit Intradoc Template screen is used to begin building a template for your component.

Element

Description

Name field

Enter the name of the template that is created for the resource, or click Select to start with a predefined template.
The unique template name is how the template is referenced in the Content Server CGI URLs and in code. When merging custom template file entries into the Templates table, the Name is used as the merge key.

Select button

Displays the Resource Selection Dialog screen, which lists the predefined templates.

Copy From check box and field

Selected = The new template resource will be a copy of an existing template. Enter the complete path and file name of the existing template file (.htm).
Clear = A new template resource file is created.

Browse button

Used to navigate to and select the desired template file.

View button

Displays the template file in a read-only text window.

Class field

Select the template class type, which is the general category of the template. The template class is not used for standard Content Server functionality, but it can be used in a component to create functions specific to a particular class of templates.

Form Type field

Select the template form type, which is the specific type of functionality the page is trying to achieve.

File name field

The file name of the template resource. This can be either an absolute path or a relative path, relative to the location of the component_template.hda resource file.

Description field

Enter a description of the template file.

Back button

Displays the Add Template Table Information screen.

Next button

Inactive (there are no more screens for defining a template).

Finish button/OK button

Saves the template file in the template resource. The Finish button is unavailable if the minimum specifications have not been defined for the resource.

Cancel button

Closes the Add/Edit Intradoc Template screen without creating or changing the template resource.

Help button

Displays this help page for the Add/Edit Intradoc Template screen.

A.3.3.22 Add/Edit Preference Screen

The Add/Edit Preference screen is used to specify custom installation parameters.

Element

Description

Name field

Name of the custom installation parameter.

Label field

Label for the parameter.

Message Type field

Select a message type.

Prompt Type field

Select the prompt type. This field is only enabled if Prompt is selected as the Message Type.

Option List Name field

Enter the result set name from the Content Server. This field is enabled when Option List is selected in the Prompt Type field.

Option List Display Column field

Enter the field name from the result set specified in the Option List Name field. This field is used for building a choice list. This field is enabled when Option List is selected in the Prompt Type field.

Message field

Enter the prompt or message text or, preferably, enter the key associated with the prompt or message (created using the code template file corresponding to the Has Install Strings check box on the Install/Uninstall Settings tab). Entering the key references the installation strings file to obtain the actual text (which can be edited for localization requirements).

Default Value field

Enter the default value for the prompt.

Always Use Default Value On Install check box

Selected = Always uses the entered default value when component is installed.
Clear = Does not use the default value when component is installed.

Is Disabled check box

Selected = The installation parameter configuration is disabled.
Clear = The installation parameter configuration is enabled.

OK button

Adds the installation parameter to the component.

Cancel button

Closes the screen without adding the installation parameter to the component.

Help button

Displays a help page for the Add Preference screen.

A.3.4 Build Screens

The following screens are used to package and build a custom component.

- Install/Uninstall Settings Tab

- Main Build Screen

- Build Settings Screen

- Advanced Build Settings Screen

- Advanced Build Settings Review Screen

A.3.4.1 Install/Uninstall Settings Tab

The Install/Uninstall Settings tab is used to create customized installation components that can include preference data parameters. These parameters can be user prompts and messages. The user prompts and messages created for specific components are displayed to users only during the installation process.

Element

Description

Has Install/Uninstall Filter check box

Selected = Includes additional custom installation or uninstall filters in the component resource definition file. Checking this option also creates the template java source if the file does not already exist. The component_nameInstallFilter.java file is created in the component_name/classes/component_name directory.
Clear = Additional custom installation procedures are not included.

Launch Editor button

Displays a code template file in the default text editor. Edit the template Java source to define custom initialization or uninstall procedures for the component (such as creating meta fields, executing service scripts, and so no)

Has Install Strings check box

Selected = Includes prompts or messages during the component installation process. These prompts or messages are stored in an installation strings file and can be edited for localization requirements. Checking this option also creates the install_strings.htm file if the file does not already exist in the component_name directory.
Clear = Prompts or messages are not included.

Launch Editor button

Displays a code template file in the default text editor. Edit the template to define prompts or messages for the component.

Preference Data Setup list

Shows the name, type and prompt fields of the custom installation parameters. If one or more custom installation parameters are defined and included, the preference.hda file is created in the component directory.

Add button

Displays the Add Preference screen, which is used to define the settings for custom installation parameters.

Edit button

Displays the Edit Preference screen, which is used to edit the settings for custom installation parameters.

Delete button

Removes the selected parameter from the component.

A.3.4.2 Main Build Screen

The Component Manager main Build screen is used during the build process, when creating a zip file of a custom component. It shows the files that will be included in the zip file.

Element

Description

Manifest Path

Shows the path and file name of the manifest.hda file, which contains the instructions for how to unpackage the component zip file.

Version field

Supports component versioning. By default, the date is listed with a build number in parenthesis, but this value can be overridden. It is used for reference purposes only, and it is not validated.

Include Preference Prompts check box

Selected = The parameter option settings (preference data) that were established using the Install/Uninstall Settings tab are included in the component manifest file. By selecting this option, the preference.hda file, which holds preference data settings, is included.
Clear = The preference data is not included in the component manifest file.

View Advanced Build Settings / Advanced button

Displays the Advanced Build Settings Review Screen which lists the field values configured using the Advanced Build Settings Screen.

Entry Type column

Lists the items that are included in the component Zip file.

Current Root Prefix column

The root directory where the component files are located.

Location column

The subdirectory or and the file name of the component file.

OK button

Builds the component Zip file.

Cancel button

Closes the screen without building the component Zip file.

Help button

Displays the help page for this screen.

A.3.4.3 Build Settings Screen

The Build Settings screen defines installation settings and what files to include in the component Zip file. The list of files included in the component Zip file is saved in the component build file (manifest.hda) and the installation settings are saved in the component definition file (component_name.hda).

Element

Description

Version field

Supports component versioning. By default, the date is listed with a build number in parenthesis, but this value can be overridden. It is used for reference purposes only, and it is not validated.

Include Preference Prompts check box

Selected = The parameter option settings (preference data) that were established using the Install/Uninstall Settings tab are included in the component manifest file. By selecting this option, the preference.hda file, which holds preference data settings, is included.
Clear = The preference data is not included in the component manifest file.

Configure Advanced Build Settings / Advanced button

Displays the Advanced Build Settings Screen which is used to enter values for the advanced build settings fields. The configured values are viewed using the Advanced Build Settings Review Screen.

Entry Type column

Lists the items that are included in the component Zip file.

Current Root Prefix column

The root directory where the component files are located.

Location column

The subdirectory or and the file name of the component file.

Add button

Displays the Add Screen.

Remove button

Removes the selected item from the list.

OK button

Saves the build settings.

Cancel button

Closes the screen without changing the build settings.

Help button

Displays the help page for this screen.

A.3.4.4 Advanced Build Settings Screen

The Advanced Build Settings screen is used to specify additional build settings for the component zip file. It is accessed by selecting the Advanced button on the Main Build Screen.

Element

Description

Content Server Compatible Build field

The minimal build number of the Content Server, for which the component must be compatible. Use this field if the component is not compatible with other Content Server versions.The build number is displayed on the application About screens and on the Configuration Information page.
The component is not installed for a Content Server build number that is older than the value specified in this field. If a build number is not specified, then the component is installed without checking the Content Server build number.

The build number is composed of four, decimal-separated numbers. If you specify a build number, during validation, if a version is missing any values, these values are padded with zeros. For example, 7.0 becomes 7.0.0.0. For example, if a component has the compatible build number set to 7.0, and it is installed against a 7.5.1 Content Server, the server would check that 7.1.2.169 > 7.0.0.0, and load the component without complaint.

Install ID field

Required if preference data is defined using the Install/Uninstall Settings tab. This field value is used during the component installation process to access the preference data stored in configuration files. Two configuration files hold the preference data: config.cfg (contains the parameters that can be reconfigured after installation) and install.cfg (contains the preference data definitions and prompt answers).

Custom Class Path field

Add class paths to additional classes or jar files that must be included in the classpath that are required for the component to function. It is recommended that you use the relative path to the Content Server and place any component-related class files or jar files in the component_name/classes directory.

Custom Library Path field

Enter the paths of library or other executable files required for the component. It is recommended that you use the relative path to the Content Server and place any component-related library or executable files in the component_name/classes directory.

Feature Extensions field

Enter the specific types of features or functions that the component provides. Separate multiple entries with commas. This field is optional (not required).

Additional Components field

This field allows installation components to install individual add-on components or to generate a grouping of multiple components into a single installation package. Enter any additional components that must be installed along with this component using the following format:
component_name:component.zip:preference_data_parameter_name

The preference_data_parameter_name is optional. If a parameter name is not specified, the component is installed by default. The preference data parameter must be defined in the Preference Data Setup section of the Install/Uninstall Settings tab.

You must include a colon (:) after component.zip even if you are not including a preference_data_parameter_name. If excluding preference_data_parameter_name, the format is: component_name:component.zip: Separate multiple entries with commas, as in the following: component_name:component.zip:,component_name:component.zip:

OK button

Returns to the previous screen.

Cancel button

Closes the screen without building the component Zip file.

Help button

Displays the help page for this screen.

A.3.4.5 Advanced Build Settings Review Screen

The Advanced Build Settings Review screen is accessed by clicking the OK button on the Build Settings Screen. It shows those options which have been specified.

Element

Description

Install ID field

Stores the user's preference settings that are specified during the component installation.

Custom Class Path field

Lists the class paths of additional classes or jar files that are included in the classpath that is required for the component to function.

Custom Library Path field

Lists the paths of library or other executable files required for the component.

Feature Extensions field

Lists the specific types of features or functions that the component provides.

Additional Components field

Lists the additional components that must be installed along with the component.

OK button

Accepts the field values and closes the screen.

Cancel button

Closes the screen.

Help button

Displays the help page for this screen.

A.3.5 Component Manager Page

The Component Manager page is used to enable and disable server components. To access the Component Manager page, select the Administration tray in the portal navigation bar, then click Admin Server. Click Component Manager in the navigation bar on the Admin Server Page.

Element

Description

Component Manager check boxes

Select an item to display a specific set of server components grouped by function. Options include:

- All Features

- Folders

- Document Management

- Inbound Refinery

- Web Content Management

- Integration

For more detailed control of components, click advanced component manager in the first paragraph, which displays the Advanced Component Manager Page. If Oracle URM is installed, click the provided link to display and control Oracle URM components.

Components check boxes

Lists available server components with short descriptions, grouped by function. To enable a component, select the check box next to the component name. To disable a component, deselect the check box next to the component name.

Update button

Updates the list of server components with the selected changes to enable or disable one or multiple components. For changes to take effect, the content server must be restarted (see the Admin Server Page).

Reset button

Resets the list of server components to their previous states (enabled or disabled).

A.3.6 Advanced Component Manager Page

The Advanced Component Manager page is used to enable, disable, install, or uninstall server components. To access the Advanced Component Manager page, select the Administration tray in the portal navigation bar, then click Admin Server. Click advanced component manager in the introductory paragraph of the Component Manager Page.

Element

Description

Additional Components check boxes

Filters the components by category for the Enabled Components and Disabled Components lists on the page. Options include:

- Show Oracle Components

- Show Custom Components

- Show System Components

Additional Filtering radio buttons

Performs additional filtering of the server components displayed on the page. Options include:

- All Components

- Folders

- Document Management

- Inbound Refinery

- Web Content Management

- Integration

Tag Filter menu

Select from the menu to filter the display of components to include components according to the tag.

Enabled Components list

Shows the server components that are currently enabled. When a component is selected, the Enabled Components Info pane displays the component information.

Disable button

Moves the selected component from the Enabled Components list to the Disabled Components list.

Disabled Components list

Shows the components that are installed but currently disabled. When a component is selected, the Disabled Components Info pane displays the component information.

Enable button

Moves the selected component from the Disabled Components list to the Enabled Components list.

Install New Component field

Enter the path of the component Zip file to be installed to the Content Server or use the corresponding Browse button.

Browse button

Used to navigate to and select an existing component Zip file.

Install button

Installs the component Zip file specified in the Install New Component field.

Reset button

Clears the Install New Component field.

Download Component field

Use the menu to select a component from the list to be downloaded to a component Zip file.

Download button

Displays a File Download screen, which is used to save the selected component as a component Zip file.

Uninstall Component field

Use the menu to select a component to be uninstalled from the Content Server. The listed components are derived from the Disabled Components list.

Uninstall button

Uninstalls the component selected from the list in the Uninstall Component field.

Update Component Configuration field

Use the menu to select the component to update the component configuration parameters. The listed parameters are those defined as being editable after the component is installed. This does not require a Content Server restart

Update button

Displays the Update Component Configuration page. Use the page to change the component configuration.

A.4 System Migration Interface

This section provides information about the interface screens used for system migration. The following topics are covered:

- "Configuration Migration Interface Screens"

- "Archive, Collection, and Batch Interface"

- "Export Interface Screens"

- "Import Interface Screens"

- "Transfer Interface Screens"

- "Replication Interface Screens"

- "Folder Archive Configuration Page"

A.4.1 Configuration Migration Interface Screens

This section provides information about the screens used to export and import configuration migration bundles.

- Migration Options

- Upload Configuration Bundle Screen

- Configuration Bundles Page

- Configuration Templates Page

- Config Migration Admin Screen

- Content Server Sections

- Preview Screen

- Edit Export Rule Screen

- Latest Action Screen

- Action History Page

A.4.1.1 Migration Options

The migration options are used to access the four basic functions of configuration migration. To access these options, select the Administration tray in the portal navigation bar, then click Config Migration Admin. You can also click the icon next to the Config Migration Admin link to expand the menu in the portal navigation bar to show links to the individual migration options.

Element

Description

Upload Bundle link

Displays the Upload Configuration Bundle Screen, used to access configuration bundles.

Configuration Bundles link

Displays the Configuration Bundles Page, used to import information from the uploaded bundles.

Configuration Templates link

Displays the Configuration Templates Page, used to access templates.

Recent Actions link

Displays the Latest Action Screen, where details about imports and exports appears.

Action History link

Displays the Action History Screen, where the history of import and export actions appears.

A.4.1.2 Upload Configuration Bundle Screen

The Upload Bundle screen is used to acquire a zipped file for use in the import process or to acquire a template file. To access this screen, select Upload Bundle from the list of Migration Options.

Element

Description

Select Bundle/Browse

Used to browse the contents of the file system to access the zipped bundle.

Create Export Template

Used to create a template based on the template that was used to create the bundle. After uploading, the template name is displayed on the Configuration Templates Page

Force Overwrite

Specifies that any information that is imported can overwrite existing content server configuration information.

A.4.1.3 Configuration Bundles Page

The Configuration Bundles Page is used to select an existing bundle for use on the current content server. To access this screen, select Configuration Bundles from the list of Migration Options.

Element

Description

Page Actions Menu

Displays the page Actions menu with the following option:
Delete All: deletes all current configuration export bundles.

Name

Displays the names of existing configuration bundles.

Source

Displays the location where the bundle was obtained.

Last Import

Displays the date and time of the last import of the bundle.

Export Date

Displays the date and time of the last export of the bundle.

Actions menu

Each bundle contains a separate Actions menu with the following options:
Edit: displays the Config Migration Admin Screen where you can alter the configuration information to be imported.

Preview: displays the Preview Screen where you can view the configuration information to be used.

Delete: used to delete the bundle.

History: displays the Action History Page where details about the import process are displayed. The title of this screen is changed to History when it is accessed from this Action menu.

Download: displays a dialog prompt, allowing you to save the zipped version of the bundle in a specified location.

A.4.1.4 Configuration Templates Page

The Configuration Templates Page lists previously defined templates and their export history. To access this screen, select Configuration Templates from the list of Migration Options.

Element

Description

Page Actions Menu

Displays the page Actions menu with the following options:
Create New Export: displays the Config Migration Admin Screen.

Delete All: deletes all current configuration export templates.

Name

Displays the names of existing configuration templates.

Description

Displays the description of the configuration templates. This description was entered on the Edit Export Rule Screen.

Last Export

Displays the date and time of the last export using this template.

Actions menu

Each template contains a separate Actions menu with the following options:
Edit: displays the Config Migration Admin Screen where you can alter the configuration information for that template.

Preview: displays the Preview Screen where you can view the configuration information to be used.

Delete: enables you to delete the template.

History: displays the Action History Page, where details about the export process are displayed (the title of this screen is changed to History when it is accessed through this action menu).

A.4.1.5 Config Migration Admin Screen

The Config Migration Admin Screen is used to determine which sections of the Content Server will be exported or imported and which actions should occur at the export or import action.

To access this screen, do one of the following:

- Select Create New Template from the page Actions menu on the Configuration Templates Page.

- Select Edit from one of the template Actions menus on the Configuration Templates Page or the Configuration Bundles Page.

- Click the template name on the Configuration Templates Page or the bundle name on the Configuration Bundles Page.

Three main areas appear on this screen:

- The page Actions menu, described in the following table.

- The Action Options section, described in the following table.

- The Content Server Sections area. See Content Server Sections for more details.

Note:
You must select Save or Save As in order for the configuration information to be saved. If you preview, edit, or re-select items, that information is not saved until you select Save or Save As from the Actions menu.

Element

Description

Page Actions Menu

Depending on which page accessed the Configuration Migration Admin page, different menu options appear:
Save or Save As: displays the Edit Export Rule Screen where you can enter the name of the template. See note below.

Preview: displays the Preview Screen where you can view the configuration to be exported or imported.

Export or Import: performs the action (Export or Import) then displays the Latest Action Screen, showing the status of the action.

Select All: selects all Content Server sections for inclusion in the configuration.

Unselect All: unselects all Content Server Sections from the configuration.

The following Action Options appear on this screen:

Element

Description

Continue on Error

Specifies that the export or import continues even if errors are encountered. Errors are reported in the status file in the entry on the Latest Action Screen.

Email results

Mails results to the user who initiated the export or import.

Add Dependencies

Selected: dependencies are added to the export or import bundle.
Unselected: dependencies are not added to the bundle.

Ignore Dependencies

Selected: If the check box is selected, dependencies are ignored.
Unselected: dependencies are not ignored. This may cause the export or import to fail. See the status file for the action on the Latest Action Screen.

Custom Name/Overwrite Duplicates

When accessed from the Configuration Templates screen, the Custom Name field appears where a unique name is generated when a bundle is created using this template.
When accessed from the Configuration Bundles screen, the Overwrite Duplicates name field appears. Selecting this option allows the importing template to overwrite any duplicate entries in the existing configuration.

A.4.1.6 Content Server Sections

The Content Server Sections is the bottom portion of the Config Migration Admin Screen. This part of the Configuration Migration Admin Screen is used to specify which aspects of the content server are included in the export template.

Each section of this screen can be further expanded to show the specific metadata fields associated with that section.

A.4.1.7 Preview Screen

The Preview Screen is used to view the content server items that will be exported or imported. To access this screen, click Preview from any of the following screens:

- The page Actions menu on the Config Migration Admin Screen

- Individual Actions menu from the Configuration Bundles Page

- Individual Actions menu from the Configuration Templates Page

The screen title changes depending on where the Preview is launched.

The other information on this screen was created using the Configuration Bundles Page or the Configuration Templates Page.

Element

Description

Page Actions Menu

Displays the page Actions menu with the following options:
Edit: displays the Config Migration Admin Screen where you can edit the configuration information.

Export or Import: performs the selected action.

A.4.1.8 Edit Export Rule Screen

The Edit Export Rule screen is used to name a template for exporting. This screen is displayed when a template is saved or edited.

Element

Description

Name

The name of the new template. Names cannot contain spaces or special characters (#, $, %, and so on).

Description

Enter a description for the template.

A.4.1.9 Latest Action Screen

The Latest Action screen displays information about the latest action. This screen refreshes automatically at a user-selectable time interval so the most recent action is displayed. To access this screen, select the Administration tray from the portal navigation bar, then click Config Migration Admin, then click Latest Action.

Element

Description

Page Refresh (In Seconds) menu

Specify the page refresh rate in seconds by selecting a time from the menu.

Time column

Displays the date and time when the action was initiated.

Section column

Displays the Content Server Section used for the action.

Message column

Displays information about the action.

A.4.1.10 Action History Page

.The Action History screen displays the history of the latest actions, those that have occurred since the last time the history file was cleared using the Clear History option on the page Actions menu. You also can use the page Actions menu to select a specific action and view its history. This screen refreshes automatically at a user-selectable time interval so the most recent actions are displayed.

This screen appears after an import or export process, or you can access this screen by selecting Action History from the top menu of any Migration screen. To directly access this screen, select the Administration tray from the portal navigation bar, then click Config Migration Admin, then click Action History.

Element

Description

Page Actions menu

Displays the page Actions menu with the following option:
Select an action: displays the history of the selected action.

Clear history: clears all history files that are displayed.

Name column

Displays the name of the action.

Source column

Displays the source of the action call.

Action column

Displays the action taken.

Start column

Displays the date and time when the action was initiated.

Status column

Displays the latest status of the action.

A.4.2 Archive, Collection, and Batch Interface

This section provides information about the screens used to create archives, collections, and batch files.

- Main Archiver Screen

- Archiver (General Tab)

- Add Archive Screen

- Copy Archive Screen

- Open Archive Collection Screen

- Find Archive Collection Definition File Screen

- Browse To Archiver Collection Screen

- Browse for Proxied Collection Screen

- View Batch Files Screen

- View Exported Content Items Screen

A.4.2.1 Main Archiver Screen

This screen can be accessed either in standalone mode, or using a browser and clicking the Administration tray in the portal navigation bar, then Admin Applets, then Archiver.

Element

Description

Options menu

Open Archive Collection: Used to open collections.
View Automation For instance: used to display and remove archives that are exported, imported, or transferred automatically.

Tracing: Displays the Tracing Configuration menu. These trace reports are available from the System Audit Information page.

Edit menu

Add: Displays the Add Archive Screen.
Delete: Deletes the selected archive.

Actions menu

Export: Used to initiate an export or to delete revisions. If automated export is enabled, this option is unavailable.
Import: Used to initiate an import and specify what data to import.

Transfer: Manually transfers the selected archive to a target archive. If a target archive is not specified or if automated transfer out of an archive is enabled, this option is unavailable.

Cancel: Cancels any active archiving process for the selected archive.

Apps menu

Used to open other administration applications. The other applications open in the same mode (applet or standalone) as the current application.

Help menu

Contents: Displays the content server online help.
About Content Server: Displays version, build, and copyright information for the content server.

Current Archives list

Lists the archives in the open collection.

General tab

Used to view archiving activity and set some export and import options.

Export Data Tab

Used to configure exports.

Import Maps Tab

Used to configure imports.

Replication Tab

Used to configure replication.

Transfer To Tab

Used to configure transfers.

Status bar

Displays the status of the Archiver or the active archiving process.

A.4.2.2 Archiver (General Tab)

The General tab is used to view archiving activity and set some export and import options. To access this screen, click the General tab on the Main Archiver Screen.

Element

Description

Last Exported field

Shows the date, time, and total number of files exported during the last export.

Last Imported field

Shows the date, time, and total number of files imported during the last import.

View Batch Files button

Displays the View Batch Files Screen, used to access batch files.

Export Options:

Element

Description

Replace Existing Export Files field

Shows if the existing export files will be replaced on the next export.

Export Table Only field

Shows if only tables are exported or if both content and tables (if defined for export) are exported.

Copy Web Content field

Shows if the native web-viewable (weblayout) files will be included in the export.

Edit button

Displays the Edit Export Options Screen, where you can specify whether to replace existing exports, copy web contents, or export tables only.

Import Options:

Element

Description

Override Action field

Shows the rule to be used to handle existing revisions during import.

Import Valid Only field

Shows if only files that have valid option list values will be imported.

Translate Date field

Shows if dates will be translated to the target content server's time zone on import.

Edit button

Displays the Edit Import Options (Select Rules) Screen, used to specify how revisions are handled.

A.4.2.3 Add Archive Screen

This screen is used to create an archive. To access this screen, on the Main Archiver Screen click the Edit menu, then select Add.

Element

Description

Archive Name field

The name of the new archive. Archive names cannot contain spaces.

Description field

A description of the archive.

Copy From check box

Selected: The new archive has the same export query and additional data as the existing archive specified in the Copy From field.
Clear: The new archive is created without an export query or additional data.

This check box appears only in the standalone Archiver.

Copy From field

The directory path and file name of the existing archive to copy from. For example, C:/stellent/archives/my_archive/archive.hda.
This field appears only in the standalone Archiver.

Browse button

Used to navigate to and select an archive to copy from. This button appears only in the standalone Archiver.

A.4.2.4 Copy Archive Screen

This screen is used to copy an archive to a different directory or file system. To access this screen, using the standalone mode for Archiver, highlight an archive name, select Edit, then click Copy To.

Element

Description

Name field

The name of the new archive. This defaults to the name of the archive being copied.

Copy Archive To Directory field

The directory path where the new archive is created. This directory must exist on the file system before copying.

Note:
This procedure copies the files in an archive. It does not create a new collection or update the collection.hda file if the archive is copied to a collection directory.

A.4.2.5 Open Archive Collection Screen

This screen is used to access sets of archives (collections). To access this screen, on the Main Archiver Screen select Options, then click Open Archive Collection.

Element

Description

Collections list

Lists the archive collections that are available to the content server instance.

Open button

Opens the selected collection. When the selected collection is already open, this button is unavailable.

Browse Local button

Displays the Find Archive Collection Definition File Screen, used to create a collection on your local system. This button is available only in the standalone Archiver.

Browse Proxied button

Displays the Browse for Proxied Collection Screen, which is used to open a collection from another content server instance. See note below.

Remove button

Removes the selected collection from the content server instance. (The collection and archive files remain in the file system, and must be deleted manually.)

Note:
In Archiver, the term 'proxied' refers to any content server to which the local instance is connected through an outgoing provider. This does not have to be a proxied instance of the master content server.

A.4.2.6 Find Archive Collection Definition File Screen

This screen is used to specify the directory and file name for a new archive collection when in standalone mode. To access this screen, click Browse Local on the Open Archive Collection Screen.

Element

Description

Look in list

Used to navigate to the directory where the new archive collection is created.

File name field

The file name of the collection definition (HDA) file. The default is collection.hda.

Open button

Displays the Browse To Archiver Collection Screen.

A.4.2.7 Browse To Archiver Collection Screen

This screen is used to define a new archive collection while using the standalone archiver. To access this screen, click Open on the Find Archive Collection Definition File Screen.

Element

Description

Name field

The name of the archive collection.
Collection names cannot contain spaces.

Use the same name as the collection directory to make navigation easier.

Location field

The path to the new collection.

Web Directory field

The path to the content server weblayout directory.

Vault Directory field

The path to the content server vault directory.

A.4.2.8 Browse for Proxied Collection Screen

This screen is used to select a collection to be opened from a remote content server. To access this screen, click Browse Proxied on the Open Archive Collection Screen.

Note:
In Archiver, the term 'proxied' refers to any content server to which the local instance is connected through an outgoing provider.

Element

Description

Proxied Servers list

Lists the name and relative web root for each remote content server.

Collections list

Lists the name and directory path of each collection on the selected remote server.

A.4.2.9 View Batch Files Screen

This screen is used to view, edit, and delete batch files. To access this screen, on the Archiver (General Tab) highlight an archive, then click View Batch Files.

Note:
This option is active only if batch files exist.

Element

Description

Batch File column

The directory and file name of each batch file in the selected archive.

Instance Name column

The name of the content server instance.

Number column

The number of content items in the batch file.

State column

The state of the batch file.
NEW: The batch file was exported manually.

AutoInsert: The batch file was exported automatically.

Import button

Imports the selected batch file.

Edit button

Displays the View Exported Content Items Screen, which is used to import or delete specific files in a batch file.

Delete button

Deletes the selected batch file from the archive.

A.4.2.10 View Exported Content Items Screen

This screen is used to import or delete specific revisions from a batch file. To access this screen, on the View Batch Files Screen highlight a batch file name, then click Edit.

Tip:
If you are importing multiple revisions of the same content item, ensure that you import the revisions in the correct order. Importing revisions out of order causes errors.

Element

Description

Use Filter check box

Select this check box to use a filter to narrow the Content list.

Define Filter button

Displays the Define Filter Screen, where you can select items for inclusion in the view.

Show Columns button

Displays the Show Columns Screen, where you can select the columns to be displayed.

Content list

Shows the revisions in the batch file that match the filter settings.
The list displays 50 revisions per page.

Double-clicking a revision displays the Information Page for that revision.

Top of list button

Displays the top of the Content list.

Previous page button

Displays the previous page of the Content list.

Import button

Imports the selected revision. See Tip below.

Delete button

Deletes the selected revisions from the batch file.

Undo button

Returns the last deleted revision to Archived status.

Apply button

Deletes any revisions that have Deleted status.

Refresh button

Returns all deleted revisions to Archived status.

Close button

Closes the screen.

Next page button

Displays the next page of the Content list.

End of list button

Displays the end of the Content list.

A.4.3 Export Interface Screens

This section provides information about the screens used during the export process.

- Main Archiver Export Screen

- Export Data (Content) Screen

- Edit Export Query (Content) Screen

- Edit Export Options Screen

- Previewing Export Queries (Content) Screen

- Main Archiver Export Screen (Table)

- Add New/Edit Table Screen

- Edit Export Query (Table) Screen

- Previewing Export Queries (Table) Screen

- Export Archive Screen

A.4.3.1 Main Archiver Export Screen

The Export Data tab of the Archiver application is used to set the export criteria for content items and tables. To access this function, click the Export Data tab on the Main Archiver Screen.

Two tabs appear on the Export Data screen:

Element

Description

Content tab

Displays the Export Data (Content) Screen.

Table tab

Displays the Main Archiver Export Screen (Table).

A.4.3.2 Export Data (Content) Screen

The Content tab is used to set the export criteria for content items. To access this screen, click the Content tab on the Main Archiver Export Screen.

Export Query pane:

Element

Description

Export Query field

Shows the export criteria that is used to select which content items will be exported.

Edit button

Displays the Edit Export Query (Content) Screen, which is used to change export criteria.

Preview button

Displays the Previewing Export Queries (Content) Screen screen, which shows what content will be exported.

Additional Data pane:

Element

Description

Content Configuration field

Shows whether content types will be exported.

User Configuration field

Shows whether user attributes will be exported.

Edit button

Displays a screen where you can specify whether to export content configuration information or user configuration information.

A.4.3.3 Edit Export Query (Content) Screen

The Edit Export Query screen is used to create an export query that defines which content items to export. A similar screen is used to create queries for tables (Edit Export Query (Table) Screen).

To access this screen:

1. Select an archive.

2. Click the Main Archiver Export Screen and the Content tab.

3. Click Edit in the Export Query section.

Query Definition pane:

Element

Description

Field list

The metadata field that is evaluated for each content item. Items matching this field are exported.

Operator field

Specifies how the Value is evaluated for each content item. The available operators depend on the type of metadata field selected:
Is exports content items with the exact value specified.

Is Not exports content items with a different value than the specified value.

Begins With exports content items with the specified value at the beginning of the field.

Contains Word exports content items with the specified value anywhere in the field.

Is Date Before exports content items with dates before the specified value.

Is Date After exports content items with dates after the specified value.

Value field

The value for the specified metadata field. Depending on the option chosen in the Field list, this field can be a text entry field, text entry field with Select button, or list of the available options.

Select button

Displays a list of existing items (such as content items or users), from which you can select a value for the Value field. This button appears only when certain metadata fields are selected.

Add button

Adds the specified export query as a new line in the Query Expression box.

Update button

Replaces the line selected in the Query Expression box with the specified export query.

Query Expression box

Shows the SQL export criteria as specified with the Add or Update buttons.

Delete button

Removes the selected line from the Query Expression box.

Custom Query Expression check box

Selected: The query expression can be edited directly.
Clear: The query expression is limited to the criteria specified in the Field, Operator, and Value fields (described previously). See the Caution and Note messages below.

Custom Query Expression box

The SQL expression that is evaluated for each content item during export. By default, multiple criteria use the AND operator.

Caution:
If you clear the Custom Query Expression check box, the expression reverts to its original definition; all modifications are lost.

Note:
You can use Idoc Script in the query expression. See the Idoc Script Reference Guide for more information.

Query Options pane:

Element

Description

Export Revisions with Release Date later than most recent Export Date check box

Selected: Exports only the revisions that have released since the last export and that meet the export criteria.
Clear: Exports all revisions that meet the export criteria.

Allow Export of Published Revisions check box

This check box is for use with Oracle Content Publisher.
Selected: Exports all revisions that meet the export criteria.

Clear: Does not export revisions that were published to the content server by Oracle Content Publisher.

All Selected Revisions option

Exports all revisions of content items that meet the export criteria.

Latest Revisions option

Exports only the most recent revision of content items that meet the export criteria.
If you are using replication, this option cannot be selected.

Not Latest Revisions option

Exports all revisions except the most recent for content items that meet the export criteria.
If you are using replication, this option cannot be selected.

Single Revision Replication option

Exports the most recent revision of each item that matches the query. This option replicates the latest revision of an item, but the replication is always renamed to revision 1 on the destination server, no matter what revision number it was on the source server.
Caution: Don't switch to Single Revision Replication if the destination server already has multiple revisions for any content item.

A.4.3.4 Edit Export Options Screen

This screen is used to specify which copies of the files to export and to specify whether to overwrite existing batch files. To access this screen, select an archive, click the Archiver General tab, then click Edit in the Export Options section.

Element

Description

Replace Existing Export Files check box

Selected: Any existing batch files are deleted from the archive when an export is initiated.
Clear: Initiating an export adds a new batch file but does not delete the existing batch files.

Copy Web Content check box

Selected: The native (vault) and web-viewable (weblayout) files are exported.
Clear: Only the native (vault) files are exported.

Export Table Only check box

Selected: Only the tables are exported. Content items are not exported.
Clear: Content items are exported and tables that have been defined to be exported.

A.4.3.5 Previewing Export Queries (Content) Screen

The Content Satisfying the Export Query screen is used to view a list of revisions that meet the export criteria.

To access this screen:

1. Select an archive.

2. Click the Main Archiver Export Screen and the Content tab.

3. Click Preview in the Export Query section.

Element

Description

Export Query field

Shows the SQL query expression created using the Edit Export Query (Content) Screen.

Use Filter check box

Select this check box to use a filter to narrow the Content list.

Define Filter button

Displays the Define Filter Screen, where you can select items for inclusion in the view.

Show Columns button

Displays the Show Columns Screen, where you can select the columns to be displayed.

Release Date Since check box and field

Limits the revisions displayed in the Content list by their release dates.

Content list

Shows the revisions in the content server repository that match the filter settings.
A maximum of 100 revisions can be displayed in this list; however, all revisions that satisfy the export query will be exported.

Double-clicking a revision displays the Information Screen for that revision.

A.4.3.6 Main Archiver Export Screen (Table)

The Table tab on the Export Data tab of the Archiver application is used to add and define the characteristics for new tables and edit existing tables in the selected archive. To access this screen, click the Main Archiver Export Screen, and click the Table tab.

Table pane:

Element

Description

Table list

Lists the tables in the selected archive.

Add button

Displays the Add New/Edit Table Screen.

Edit button

Displays the Edit Archive Properties screen. See the Add New/Edit Table Screen.

Delete button

Deletes the selected table from the archive.

Export Query pane:

Element

Description

Export Query field

Shows the export criteria that is used to select which tables will be exported.

Edit button

Displays the Edit Export Query (Table) Screen.

Preview button

Displays the Previewing Export Queries (Table) Screen.

A.4.3.7 Add New/Edit Table Screen

The Add New/Edit Table screen is used to define the export characteristics of a table and add it to the selected export archive.

To access this screen:

1. Click the Main Archiver Export Screen.

2. Select an archive from the Current Archives list and click the Tables tab.

3. Click the Table list Add button.

Element

Description

Table Name list

Lists the available database tables that can be added to the selected archive.

Use Parent Timestamp check box

Selected: Use the parent table's timestamp to determine if this table will be exported.
Clear: Use the current timestamp to determine if this table will be exported.

Create Timestamp list

Lists the possible columns that store the creation timestamp when the table row is created.

Modify Timestamp list

Lists the possible columns that store the modification timestamp when the table row is modified.

Parent Table list

Lists parent table selections.

Table Relations field

Used to specify the parent / child table relationship that determines the information to be exported.

Create New Table or Field if Not Exist check box

Selected: Creates the specified table or field if it does not currently exist.
Clear: Does not create the table or field.

Use Source ID check box

Selected: Only table rows that match in multiple instances are exported.
Clear: Table rows are exported regardless of their matching status between instances.

Replicate Deleted Rows check box

Selected: The deleted source table rows are also deleted in the target table.
Clear: Rows are not deleted in the target table.

Delete before Importing All Child Rows with Modified or Deleted Parent check box

Selected: Delete the rows from the importing child table if the corresponding rows in the parent table have been deleted or modified.
Clear: Rows are not deleted in the child table before importing.

Allow Archiver to Delete Row from Parent Table check box

Selected: Delete the rows from the parent table if the corresponding rows in the exported child table have been deleted.
Clear: Rows are not deleted from the parent table.

Delete Parent Row Only if No Associate Child Exists check box

Selected: Delete the rows from the parent table only if a child row does not exist.
Clear: Rows are not deleted from the parent table.

A.4.3.8 Edit Export Query (Table) Screen

The Edit Export Query screen is used to create an export query that defines which tables to export. This is similar to the screen used to create export queries for content (Edit Export Query (Content) Screen).

To access this screen:

1. Select an archive

2. Click the Main Archiver Export Screen and the Table tab.

3. Click Edit in the Export Query section.

Element

Description

Field list

The metadata field that will be evaluated for each table.

Operator field

Specifies how the Value will be evaluated for each table. The available operators depend on the type of metadata field selected:
Is exports tables with the exact value specified.

Is Not exports tables with a different value than the specified value.

Begins With exports tables with the specified value at the beginning of the field.

Contains Word exports tables with the specified value anywhere in the field.

Is Date Before exports tables with dates before the specified value.

Is Date After exports tables with dates after the specified value.

Value field

The value for the specified metadata field.

Add button

Adds the specified export query as a new line in the Query Expression box.

Update button

Replaces the line selected in the Query Expression box with the specified export query.

Query Expression field

Shows the export criteria.

Delete button

Removes the selected line from the Query Expression box.

Custom Query Expression check box

Selected: The query expression can be edited directly.
Clear: The query expression is limited to the criteria specified in the Field, Operator, and Value fields. See the caution and note messages below.

Custom Query Expression field

The SQL expression that will be evaluated for each table during export. By default, multiple criteria use the AND operator.

Caution:
If you clear the Custom Query Expression check box, the expression reverts to its original definition; all modifications are lost.

Note:
You can use Idoc Script in the query expression. See the Idoc Script Reference Guide for more information.

A.4.3.9 Previewing Export Queries (Table) Screen

The Content Satisfying the Export Query screen is used to view a list of tables that meet the export criteria. The fields, buttons, and check boxes on this screen are identical to those on the screen used to view a list of revisions meeting selected export criteria.

To view and read the field descriptions, see the Previewing Export Queries (Content) Screen.

A.4.3.10 Export Archive Screen

The Export Archive screen is used to initiate an export and specify whether to delete the exported files. To access this screen, select Actions, then select Export from the Archiver menu bar.

Element

Description

Delete revisions after successful archive check box

Selected: Deletes exported revisions from the content server instance upon successful export.
Clear: Exported revisions are not deleted from the content server.

A.4.4 Import Interface Screens

This section provides information about the screens used during the import process.

- Import Maps Main Screen

- Import Maps (Content) Screen

- Edit Field Map/Edit Value Map Screen

- Browse for Fields/Value Screen

- Import Maps (Table) Screen

- Edit Archive Properties on Table Screen

- Edit Import Options (Select Rules) Screen

- Import Archive Screen

A.4.4.1 Import Maps Main Screen

'Mapping' determines how metadata fields on an exporting and importing content server relate to each other.

The Import Maps tab of the Archiver application is used to configure metadata field and value mappings to import content items and tables. To access this tab, click the Import Maps tab on Main Archiver Screen.

Two tabs appear on the main mapping screen:

Element

Description

Content tab

Displays the Import Maps (Content) Screen.

Table tab

Displays the Import Maps (Table) Screen.

A.4.4.2 Import Maps (Content) Screen

The Content tab on the Import Maps screen is used to set the import criteria for content items. To access this screen, click the Content tab on the Import Maps Main Screen.

Element

Description

Field Maps box

Shows the metadata field mapping expression.

Edit button

Displays the Edit Field Map/Edit Value Map Screen.

Value Maps box

Shows the metadata value mapping expression.

Edit button

Displays the Edit Field Map/Edit Value Map Screen.

A.4.4.3 Edit Field Map/Edit Value Map Screen

The Edit Field Map/Edit Value Map screen is used to set how fields and values are copied (mapped) from one metadata field to another during import.

Follow these steps to access this screen:

1. Click the Import Maps Main Screen

2. Select an archive from the Current Archives list

3. Click the Import Maps (Content) Screen and click Edit in the Field Maps section or the Value Maps section.

Element

Description

'All' check box

On the Edit Value Maps Screen, if the 'all' check box is selected, the specified Field is changed to the Output Value for all imported revisions.

Export Field/Input Value

The metadata field that contains the data to be copied to a different field during import or the metadata value to be changed when mapping values. Use the internal field name, such as dDocAuthor or xComments.

Export Field/Input Value list

Enables you to select the Export Field or Input Value from a list of existing metadata fields. A source must be selected from the Browse for Fields/Value Screen for options to appear in this list.

Browse For Fields/Browse for Values button

Displays the Browse for Fields/Value Screen.

'in' Field

On the Edit Value Maps Screen, an additional field appears between Input Value and Output Value. Select the field where the metadata should be changed from the list.

Target Field/Output Value

The metadata field that the archived metadata is copied to during import. The list includes all metadata fields in the local content server.

Add button

Adds the specified mapping expression to the Field Maps box.

Update button

Replaces the mapping expression selected in the Field Maps box with the specified mapping expression.

Field MapsValue Maps box

Shows the mapping expressions.

Delete button

Deletes the selected mapping expression from the Field Maps box.

A.4.4.4 Browse for Fields/Value Screen

The Browse for Fields/Value screen is used to specify whether to retrieve a list of metadata fields from the local content server or from a specific batch file. To access this screen, click Browse for Fields or Browse for Value on the Edit Field Map/Edit Value Map Screen.

Element

Description

From Batch File list

On the Browse for Values screen, selecting a batch file retrieves the list of metadata fields defined in that batch file.

From Field list

On the Browse for Values screen, selecting a field retrieves a list of metadata values defined for that field in the batch file.

Local System option

Retrieves a list of metadata fields from the local content server.

Batch option

Retrieves a list of metadata fields from the selected batch file.

A.4.4.5 Import Maps (Table) Screen

The Table tab on the Import Maps screen is used to add and define the field and value maps for importing tables. To access this screen, on the Import Maps Main Screen click the Table tab.

Element

Description

Archive file list

Provides a tree-view list of archive files.

Edit button

Displays the Edit Archive Properties on Table Screen. The configuration settings on this screen that display after clicking the Edit button are the global configurations. The settings on the top section of the screen cannot be edited. Changes to the global settings on the bottom section are implemented after clicking OK. Changes made using the Load button can override these changes.

Load button

Displays the Edit Archive Properties on Table Screen. The configuration settings on this screen that display after clicking the Load button are the configuration settings defined when the archive was created. The settings on the top section of the screen cannot be edited. Changes to the settings on the bottom section are implemented after clicking OK. These changes will override the changes made using the Edit button.

Refresh button

Used to update the current archive file list.

Field Maps box

Shows the metadata field mapping expression.

Edit button

Displays the Edit Field Map/Edit Value Map Screen.

Value Maps box

Shows the metadata value mapping expression.

Edit button

Displays the Edit Field Map/Edit Value Map Screen.

A.4.4.6 Edit Archive Properties on Table Screen

The Edit Archive Properties screen is used to edit the original check box values assigned to the table when it was created. The fields in the top section are no longer editable. Only the configuration settings in the lower section can be changed. This screen displays after clicking both the Edit and Load buttons associated with the archive file list section on the Import Maps Table tab screen.

The configuration settings are different depending on which button was clicked to display the screen. The settings that are displayed after clicking the Edit button are the global configurations and the settings that display after clicking the Load button are those that were defined when the archive was created. Changes made using the Edit-generated screen can be overridden with changes made using the Load-generated screen.

The fields and check boxes on this screen are identical to those on the screen used to add a table to an archive. To view field descriptions, see the Add New/Edit Table Screen.

Follow these steps to access this screen:

1. Click the Import Maps Main Screen.

2. Select an archive from the Current Archives list.

3. Click the Import Maps (Table) Screen.

4. Click the Table list Edit button.

Screens similar to those used to edit content appear:

- The Edit Field Maps screen is used to set up how values will be copied from one metadata field to another during the import of tables. The fields and buttons on this screen are identical to those on the screen used to set the metadata mapping for imported content items. See the Edit Field Map/Edit Value Map Screen.

- The Browse for Fields screen is used to specify whether to retrieve a list of metadata fields from the local content server or from a specific batch file. The fields on this screen are identical to those on the same screen associated with the Import Maps Content tab. See the Browse for Fields/Value Screen.

- The Edit Value Maps screen is used to set up how metadata values will be changed (mapped) during the import of tables. The fields and buttons on this screen are identical to those on the screen used to set the metadata values for imported content items. See the Edit Field Map/Edit Value Map Screen.

- The Browse for Values screen is used to select metadata values to retrieve from a batch file. The fields on this screen are identical to those on the same screen associated with the Import Maps Content tab. See the Browse for Fields/Value Screen.

A.4.4.7 Edit Import Options (Select Rules) Screen

The Edit Import Options screen is used to specify how revisions are replaced, added, or deleted during import. To access this screen, click Edit in the Import Options section of the Archiver (General Tab).

Element

Description

Override Import Rules list

Select the rule that defines how revisions are replaced, added, or deleted during import. Selecting an option displays a description of the import rule. See the Caution message below.

Import only revisions with valid option list values check box

Selected: Values in validated option lists are checked, and only revisions with valid option list values will be imported.
Clear: Option list values are not validated during import.

Translate the dates to the current system time zone check box

Selected: Times in metadata date fields are recalculated to reflect the time zone of the target (import) content server.
Clear: Times in metadata date fields remain unchanged during import.

Caution:
The Update import rule will replace existing revisions without saving the existing files. Be extremely careful when importing so that you do not accidentally replace content you meant to keep.

A.4.4.8 Import Archive Screen

The Import Archive screen is used to initiate an import and to specify what information to import. To access this screen, select Actions, and then click Import from the Archiver menu bar.

Element

Description

Import Batched Revisions check box

Selected: Imports content item revisions.
Clear: Does not import content item revisions.

Import Tables check box

Selected: Imports content item revisions and tables in an archive that contains both.
Clear: Does not import the tables in an archive that contains both content item revisions and tables.

A.4.5 Replication Interface Screens

This section provides information about the screens used in the replication process.

- Main Archiver Replication Screen

- Registered Exporter Screen

- Automation (Exporters) Screen

- Automation (Importers) Screen

- Automation (Transfers) Screen

- Automation (Queries) Screen

A.4.5.1 Main Archiver Replication Screen

The Replication tab of the Archiver application is used to configure automated exports and imports. To access this screen, click the tab on the Main Archiver Screen.

Element

Description

Export Automated field

Shows whether automatic export is enabled for the selected archive.

Registered Exporters box

Lists the collections that are currently registered as automatic exporters for the selected archive.

Edit button

Displays the Registered Exporter Screen.

Registered Importer field

Shows the collection that is currently registered as an importer for the selected archive.

Logon User Name field

Shows the user name of the user who was logged in when the importer was registered.

Register Self button

Registers the selected archive as an automatic importer.

Unregister button

Unregisters the registered importer.

A.4.5.2 Registered Exporter Screen

The Registered Exporter screen is used to specify which collections automatically export to the current archive, and to enable and disable automatic export. To access this screen, click Edit on the Main Archiver Replication Screen.

Element

Description

Enable Automated Export check box

Selected: Export will occur automatically whenever a content item that meets the export criteria is indexed.
Clear: Automatic export is disabled.

Registered Exporters box

Lists the collections that are registered as automatic exporters for the selected archive.

Register button

Adds the current collection to the list of registered exporters. This button is not available if automatic export is disabled.

Remove button

Removes the selected collection from the list of registered exporters. This button is not available if automatic export is disabled.

A.4.5.3 Automation (Exporters) Screen

The Automation Screen has three tabs: Exporters, Importers, and Transfers. To access the Automation screen, highlight a collection and select View Automation for instance from the Options menu on Main Archiver Screen

The Exporters tab of the Automation for Instance screen is used to view and remove archives that are being exported automatically.

Element

Description

Location column

Lists the collection and archive for each archive that is being exported automatically.

Status column

Shows the status of the automatic export: connected or disconnected.

Remove button

Removes the selected archive as a registered exporter.

A.4.5.4 Automation (Importers) Screen

The Importers tab of the Automation screen is used to view and remove archives that are being imported automatically.

Element

Description

Location column

Lists the collection and archive for each archive that is being imported automatically.

Status column

Shows the status of the automatic import: connected or disconnected.

Remove button

Removes the selected archive as a registered importer.

A.4.5.5 Automation (Transfers) Screen

The Transfers tab of the Automation screen is used to view and remove archives that are being transferred automatically.

Element

Description

Source column

Lists the collection and archive for the transfer source.

Target column

Lists the collection and archive for the transfer target.

Status column

Shows the status of the automatic transfer: connected or disconnected.

Remove button

Removes the selected transfer.

A.4.5.6 Automation (Queries) Screen

The Queued Automated Imports screen is used to view those imports that are queued to occur.

Element

Description

Location column

Lists the collection and archive for the transfer source.

Status column

Shows the status of the automatic transfer.

Remove button

Removes the selected transfer.

A.4.6 Transfer Interface Screens

This section provides information about the screens used to transfer archives.

- Main Archiver Transfer Screen

- Transfer Options Screen

- Archive Collections Screen

A.4.6.1 Main Archiver Transfer Screen

The Transfer To tab of the Archiver application is used to configure batch file transfers from one archive to another. To access this tab, click the Transfer To tab on Main Archiver Screen.

Element

Description

Last Transfer Out field

The date and time that batch files were last transferred out of the selected archive.

Last Transfer In field

The date and time that batch files were last transferred into the selected archive.

Total fields

The number of batch files and content items that were included in the last transfer.

Transfer Options pane:

Element

Description

Is Targetable field

Shows whether the selected archive can be a transfer target.

Is Transfer Automated field

Shows whether the selected archive is transferred automatically.

Edit button

Displays the Transfer Options Screen.

Transfer Destination pane:

Element

Description

Transfer Owner field

The content server instance that owns the transfer for the selected archive.

Target Archive field

The collection and archive that the selected archive will be transferred to.

Remove button

Deletes the transfer destination.

Edit button

Displays the Archive Collections Screen.

A.4.6.2 Transfer Options Screen

The Transfer Options screen is used to enable an archive to receive a transfer and to automate transfers out of an archive. To access this screen, click Edit in the Transfer Options section of the Main Archiver Transfer Screen.

Element

Description

Is Targetable check box

Selected: The selected archive can receive transfers from other archives.
Clear: The selected archive cannot receive transfers from other archives.

Is Transfer Automated check box

Selected: Transfer of the selected archive occurs automatically, whenever the archive is updated.
Clear: Transfer of the selected archive must be initiated manually.

A.4.6.3 Archive Collections Screen

The Archive Collections screen is used to specify a targetable archive to receive a transfer. To access this screen, click Edit in the Transfer Destination section of the Main Archiver Transfer Screen.

Element

Description

Collections list

Lists the names and locations of archive collections that are available to the local content server.

Archives list

Lists the name and targetable status of the archives in the selected collection. (Only targetable archives can be selected from this list.)

A.4.7 Folder Archive Configuration Page

This page is used to manage and create folder archives. To access this page, log in to the content server as an administrator, click the Administration tray in the portal navigation bar, then click Folder Archive Configuration.

Element

Description

Collection Name list

The list includes all detected archive collections on the content server (that is, all collections that are known or have been opened in Content Server's Archiver utility).
Each content server will at least have one archive collection, which has the same name as the content server instance.

Archive Name field and list

Here you can specify the name of the archive. The list contains all known archives on the content server that were created earlier.
Ensure that you provide an archive name before selecting folders to be included in the archive. If you select folders first and then specify an archive name, nothing happens when you click Add. (The folder tree collapses completely and your folder selection is lost).

Folder tree

This shaded area contains the folder structure that is detected on the content server.
By default, the entire tree is collapsed (that is, none of the folders are displayed).

Click the plus symbol to display all underlying subfolders of a folder, and the minus symbol to hide them.

Select the check boxes of all folders that you want to include in the folder structure archive. If you click the check box of a parent folder, all its child folders are selected automatically as well. You can also select and unselect any of the child folders individually. A parent folder will only be selected if all of its subfolders are selected as well. If you unselect any of the child folders, its parent folder is automatically unselected, too. This does not affect the virtual folder path properties of the child folder.

The folder tree will include any Collaboration Manager project folders and Site Studio Web site folders. The Folder Structure Archive component is not intended to archive these folders. You can archive them and also transfer them to another system, but transferred collaboration projects and Site Studio Web sites will not work on the target system.

Add button

Click this button to create the specified folder archive and make it available in Content Server.
Ensure that you provide an archive name before selecting folders to be included in the archive. If you select folders first and then specify an archive name, nothing happens when you click Add. (The folder tree collapses completely and your folder selection is lost).

Remove button

Click this button to remove the specified existing folder archive, so it is no longer available in the Content Server for processing.

B Need to Know Component

This appendix provides information for installing and using the Need to Know component, which can not be installed or enabled using the Component Manager.

- "Introduction"

- "Installing the NTK Component"

- "Configuring the NTK Component"

- "Using the Need To Know Component"

- "NTK Administration Interface"

B.1 Introduction

The Need to Know (NtkDocDisclosure or NTK) component supports customization for these Content Server security areas:

- Content security: Changing user access to content items.

- Search results: Modifying the display of search results.

- Hit list roles: Changing user credentials for query and check-in pages.

- Content metadata security: Altering the behavior of metadata changes for content items.

- WHERE clause calculation: Modifying use of the WHERE clause in searches.

For example, with standard security, users can only view content for which they have at least Read permission. The Need to Know component can change this in two ways:

- All users can be allowed to see content items from specified security groups in a search results list, even though they may not be able to view the metadata or document itself.

- Read and Write permission can be expanded or restricted within specified security groups using a query against content metadata and user attributes.

The Need to Know component provides an HTML administration interface to display security configuration status information, enable editing of security configuration values, and enable viewing and testing of Idoc Script for security configuration values.

Note:
Oracle Secure Enterprise Search does not have the ability to understand the Need To Know security rules to map the information into an Oracle Secure Enterprise Search instance. Therefore, any documents using Need to Know can not be configured to be sent to Oracle Secure Enterprise Search.

B.1.1 Features

The Need to Know function is implemented through the following features:

- The Need to Know component is applied by security group. You must identify which security groups will use the component. All content in the specified security groups will appear in the search results for all users.

- This component provides the option of making all accounts visible, so a user can get a search “hit” on a content item regardless of its account.

- The Security Group list on the Search page will show all specified security groups. If accounts are enabled, all accounts will appear in the Accounts list on the Search page.

- A new “DocDisclosureQuery” metadata field and new “hit list” role must be created to support the Need to Know function. The hit list role is given read access to all specified security groups.

- You can create new user attribute fields or use existing ones in Need to Know queries.

- When a document is checked in, a query can be defined in the “DocDisclosureQuery” metadata field. The query conditions can include content metadata and user attributes, and the query results determine access permission to the document. Queries can be entered manually in Idoc Script, or the Disclosure Query Security applet can be used to build the query.

- Whenever a user does a search, the hit list role is dynamically applied to the user, giving them read access to all content in the specified security groups. Each content item is then checked for a query in the “DocDisclosureQuery” field, which determines the user's access to that content item.

- If the “DocDisclosureQuery” field is empty, standard security applies. Standard security can also be explicitly specified in the query field, or it can be used in a boolean combination with other document and user attributes to expand or refine the read access.

- If a query is entered for a content item that is not in an NTK security group, the query does not run, and standard security applies.

- If a user already has more than Write or higher access to the security group, the query in the “DocDisclosureQuery” field does not run, and standard security applies.

- A global query can be defined for all content, so individual queries do not have to be specified for each content item. You can set up the system to allow the global query to be overridden when a query is entered during check-in.

B.1.2 Applications

This component can be used as the starting point for a more complicated security implementation, such as:

- Providing integrated tracking for downloads of sensitive documents.

- Controlling Write or higher privileges through custom logic.

- Implementing view limits and subscription control, where documents within a certain security group may only be downloaded so many times.

- Controlling access by incorporating entries from a custom database table or results from a custom API. This is a hook for externally controlled authorization.

B.2 Installing the NTK Component

Install the component using either the Component Wizard or the command-line ComponentTool as follows:

Installing the NTK component with Component Wizard:

1. Launch the Component Wizard.
For information on using standalone applications, see "Running Administration Applications in Standalone Mode".

2. On the Component List screen, select Options, then Add.
The "Add Component Screen" displays.

3. Select the radio button for Use Existing Component.

4. Browse to the location where the Enterprise Content Management (ECM) shiphome was installed. For example:

ECM_HOME\ucm\idc\components\NeedToKnow

5. Select the NeedToKnow.hda file and click OK.

6. Click Enable.
The NTK component is listed as enabled.

Installing the NTK component with ComponentTool:

Run the Component Tool and specify the NeedToKnow.hda file with the following path, using your configuration name and path for ECM_HOME:

ECM_HOME\ucm\idc\components\NeedToKnow\NeedToKnow.hda

B.3 Configuring the NTK Component

This section describes the procedure to set up a basic security configuration using the Need to Know component. This procedure explains how to set up security configuration variables, a custom metadata field, and a hit list role. After you have set up the basic configuration, you can use the Need to Know component interface to edit, test, and improve the security configuration.

Note:
You must open the Admin Server page for the applicable Content Server instance before starting the procedure.

1. Select the General Configuration link on the side bar in the Admin Server page.

2. Under the Additional Configuration Variables heading on the Admin Server: General Configuration Page, scroll to the bottom of the text area, and add the following text:

SpecialAuthGroups=group1,group2,...

- Replace group1,group2,... with the security groups that will use the Need to Know component.

- Security groups must be entered in lower case.

- Any security groups not listed will have standard security applied.

Note:
Other products such as Records Management also can use the SpecialAuthGroups configuration variable, so be careful to use unique names for security groups that will use the Need to Know component.

3. If you want to specify content item-level queries, use the Configuration Manager to add a new metadata field. (This is not necessary if you will be using only the global query.) A new metadata field must be added by using the Configuration Manager; it cannot be added from the Need to Know component interface.

- You can use any field name and title you wish, such as DocDisclosureQuery or NeedToKnow.

- The field must be specified as a memo field.

- After adding the field, you will need to click Update Database Design, and then click Rebuild Search Index.

Note:
If your Content Server instance already has a large amount of content, rebuilding the search index can take a long time (up to a couple of days). Consider rebuilding during system maintenance periods or at times of non-peak system usage.

4. Use the User Admin administration applet to add a hit list role.

- You can use any role name you wish, such as hitlist or NTKrole.

- Give Read access to all the security groups that were specified in the SpecialAuthGroups configuration entry.

- If you want the security groups that were specified in the SpecialAuthGroups configuration entry to be listed on the check-in page or update page, you will need to give Write access to this role.

- You can create two different hit list roles with different names and permissions. One role can be configured with the Need to Know component to be a Query role in a content search, and the other role can be configured with the Need to Know component to be an Update role in content check-ins and updates.

- Do not assign this role to any users. If the hit list role is configured to be a Query or Update role, it is automatically added to the user's attributes.

5. If you want to set user access permissions that extend the limits of Need to Know security, use the General Configuration page to include extra security configuration settings in the Additional Configuration Variables section. Scroll to the bottom of the text area and enter the configuration settings as necessary.

6. If you want to add new user attribute fields for use in Need to Know queries, use the User Admin tool to add user attribute fields.

7. Restart the content server.

Note:
When the Need to Know component has been installed, certain security configuration values are stored in the IntradocDir/data/needtoknow/ntk_config.hda file. These values can be edited by using the Need to Know administration interface, described in "NTK Administration Interface", or by directly editing the ntk_config.hda file.

B.4 Using the Need To Know Component

This section covers the following topics:

- "Security Configuration Customization"

- "Disclosure Query Security Applet"

- "Query Syntax"

- "Defining a Content-Level Query"

- "NTK Configuration Information Page"

B.4.1 Security Configuration Customization

The Need to Know component provides additional security configuration support focused on the following areas:

- Content Security: Changing user access to content items.

- Search Results: Changing the display of search results.

- Hit List Roles: Changing user credentials for query and check-in pages.

- WHERE Clause Calculation: Changing use of the WHERE clause in searches.

- Content Metadata Security: Changing the behavior of metadata changes for content items.

B.4.1.1 Content Security

Standard security uses security roles, groups, and accounts to determine if a user has the appropriate privilege level to access a content item. The Need to Know component enables you to customize the process of determining user privilege. You can use the Need to Know component interface to set configuration fields and create Idoc Script to specify Read, Write, and Delete privilege levels. The Idoc Script can also contain user and content metadata values.

The Need to Know component computes content security using the following process:

1. A user clicks a link to view content information.

2. If the user has the “admin” role, standard security is used and the user can view the content.

3. If the security group of the content item is not a Need to Know authorization group, then standard security is used to evaluate the user's Read request.

4. If Need to Know security is not enabled at the Read privilege level, then standard security is used to evaluate the user's Read request.

5. If Need to Know security is not limited at the Read privilege level, and the user has standard security access to the content item, the user is given access to the content.

6. The Need to Know security Idoc Script (in this case the Read security script) is evaluated.

7. The Need to Know access flag (in this case, isNTKReadAccess) is evaluated to determine if the user has access to the content. Access is allowed or denied based on the Need to Know access flag.

The Need to Know component also enables you to test security configuration scripts for each access level: Read, Write, and Delete. For a test you can specify a user and a content ID, and you have the option of specifying roles and accounts. These attributes are used in the test instead of the user's actual attributes. For example, you could test Idoc Script using an external user whose attributes may not be accessible. After the test is run, the component reports on whether the user has access to the content item, whether Need to Know security was used, and if Need to Know security was not used then the reason why.

For information on using the Need to Know component interface to configure content security, see the "NTK Configuration Information Page" and the "Content Security Configuration Information Page". For samples of Idoc Script that can configure content security, see "Security Customization Samples".

The following Idoc Script functions can be used in the Script fields to determine content security. For additional information on Idoc Script refer to the Idoc Script Reference Guidel.

Idoc Script Function

Description

allStrIntersect

Takes two required comma-delimited strings and one optional Boolean flag as parameters. If all values in the second string occur in the first string, the function returns true. If the optional parameter is set to true and the second value is an empty string, the function returns true. By default, the optional parameter is false. The comparison of values in the comma-delimited strings are not case sensitive.

includeNTKDeleteSecurityScript

Evaluates the Delete security script and makes the isNTKDeleteAccess variable available for use in the Read or Write security scripts. If this function is used in the Delete security script, it is ignored.

includeNTKReadSecurityScript

Evaluates the Read security script and makes the isNTKReadAccess variable available for use in the Write or Delete security scripts. If this function is used in the Read security script, it is ignored.

includeNTKWriteSecurityScript

Evaluates the Write security script and makes the isNTKWriteAccess variable available for use in the Read or Delete security scripts. If this function is used in the Write security script, it is ignored.

isDisclosureQuery

Evaluates the query for the disclosure field (if specified) and returns true or false. An optional parameter can be specified to determine if the function should return true or false if the disclosure query is empty. If the disclosure field has not been specified or does not exist, this function always returns false.

isMetaChange

This variable is set if the content security call involves a content update or a check in.

isStrIntersect

Takes two required comma-delimited strings and one optional Boolean flag as parameters. If at least one value in the second string occurs in the first string, the function returns true. If the optional parameter is set to true and the second value is an empty string, the function returns true. By default, the optional parameter is false. The comparison of values in the comma-delimited strings are not case sensitive.

stdSecurityCheck

Checks standard security for the current access level. For example, if the function is in the Read security script, it checks security at the Read access level.

B.4.1.2 Search Results

The Need to Know component enables you to customize the presentation of the search results that are returned from a search query. Two configuration values can be set using the NTK interface: Hidden Fields, and Script.

The Hidden Fields value is a list of fields that can be hidden from view on the Search Results page. The values are set to empty strings. To hide the fields, the field hideFields must be set in the component search results Idoc Script.

Idoc Script controls the presentation of the search results. Idoc Script is evaluated for each row in the search results. A number of fields can be set in script to alter the presentation of search results. To see the list of fields and how to use the Need to Know component interface to customize script for search results presentation, see "Search Results Configuration Information Page".

The Need to Know component uses the securityCheck Idoc Script function to determine search results presentation. The securityCheck function checks the security against the current content item (standard security or Need to Know security), depending on the configuration values. The function has an option parameter to determine what access level to check:

- 1 = Read

- 2 = Write

- 4 = Delete

- 8 = Admin

If no parameter is used with securityCheck, by default it checks the Read access level.

For examples of Idoc Script that can alter search results presentation, see "Security Customization Samples".

B.4.1.3 Hit List Roles

Hit list roles enable you to change user credentials for using content Search, Content Check In, and Update pages. Using the User Admin applet, you can add a hit list role with any name you wish. You don't assign the role to a user; when the role is enabled it is automatically added to a user's attributes when doing a search, check in, or update. When creating a hit list role, you need to give Read access to all the security groups that you specify in the SpecialAuthGroups configuration entry. If you want these security groups to be listed on the Content Check In page or Update page, you also need to add Write access to the hit list role.

Using the Need to Know component Hit List Roles Configuration Information page, you can implement hit list roles in two forms: Query and Update. A hit list role used in a query is applied to content searches. A hit list role used in an update is applied to content check-ins and updates.

For additional information about how to use hit list roles, see "NTK Configuration Information Page" and "Hit List Roles Configuration Information Page". For samples of using hit list roles, see "Security Customization Samples".

B.4.1.4 WHERE Clause Calculation

The Need to Know component provides two filters that enable you to customize the query WHERE clause that is used to retrieve search results:

- preDetermineWhereClause: Overrides the entire WHERE clause.

- postDetermineWhereClause: Appends to the standard security WHERE clause.

The code for these filters is located in the NTKFilter Java class. For samples of how these filters work, see "Security Customization Samples".

B.4.1.5 Content Metadata Security

The Need to Know component provides a filter called checkMetaChangeSecurity that enables you to alter the behavior of metadata changes when a content item is checked in or updated.

The code for this filter is located in the NTKFilter Java class. For an example of how the filter works, see "Security Customization Samples".

B.4.2 Disclosure Query Security Applet

The Disclosure Query Security applet is used to define a query for a particular content item during check-in.To access the applet, click the Update button next to the DocDisclosureQuery field on the Content Check In Form page.

Element

Description

Field field

Select a user attribute field to be specified in the query. This list includes User Locale, User Name, User Role, and all of your custom user attribute fields.

Operator field

Select an operator to apply to the Field and Value. The following operators are used for all fields except User Role:
Is: The value in the specified Field matches the specified Value.

Is Not: The value in the specified Field does not match the specified Value.

Begins With: The value in the specified Field starts with the specified Value.

Contains: The value in the specified Field contains the specified Value.

The User Role field has only one operator, Has Member, and displays a drop-down list of roles in the Value field.

Value field

Enter the value to be specified in the query.

- If an option list was specified for the selected field, choose the value from the drop-down list.

- If no option list was specified for the selected field, type the value in the text box.

Add button

Enters the query specified by the Field, Operator, and Value fields into the Query Expression text box. Each click of the Add button appends the current settings to the query as an AND clause.

Update button

Updates a selected query clause with the parameters specified in the Field, Operator, and Value fields

Merge button

Creates an OR clause (inserts a pipe character) for the selected query clause. This button is enabled under the following conditions:

- The Field in the drop-down list matches the Field specified in the selected query clause.

- The Operator in the selected query clause cannot be “Is Not”.

- The Operator in the drop-down list cannot be “Is Not”.
Note: The pipe character does not appear in the Query Expression for a User Roles query clause, but it will appear in the DocDisclosureQuery field.

Query Expression

Displays each clause of the query as a single line.

Delete button

Deletes the selected query clause.

Append button

Appends the Query Expression to any existing query in the DocDisclosureQuery field on the Content Check In Form page.

Replace button

Replaces any existing query in the DocDisclosureQuery field on the Content Check In Form page with the Query Expression.

Cancel button

Closes the Disclosure Query Security applet without applying any query changes.

B.4.3 Query Syntax

The Disclosure Security Query applet creates queries with the correct Idoc Script syntax, but you can also enter your own queries directly in the DocDisclosureQuery field. The following Idoc Script syntax is used in disclosure queries:

- "Like Operator"

- "Boolean Operators"

- "UserName Variable"

- "stdSecurity Variable"

- "User Attribute Fields"

- "User Roles"

Note:
You can learn how to correctly format query clauses for direct entry in the DocDisclosureQuery field by experimenting with the Disclosure Query Security Applet (page 3-6)

B.4.3.1 Like Operator

The like operator matches substrings and wildcard strings. Enclose all strings in single quotes.

B.4.3.1.1 Substrings

Use the like operator to match substrings.

B.4.3.1.2 Wildcard Strings

Use wildcard strings to match variable characters and options. Wildcard strings use the syntax

* = Match 0 or more characters

? = Match exactly 1 character

| = Separates multiple options, only one of which needs to match

For example, the following code would match “MyClient”, “3rd Quarter MyClient Report”, “MyClient Visit”, “Meeting with MyClient”, and “1996 Reports”. This string would not match “My Client”, “All 1996 Reports”, or “1996 Report”.

dDocName like '*MyClient*|199? Reports'

B.4.3.2 Boolean Operators

Query clauses can be joined by and, or, and not Boolean operators.

- The Boolean operators must be lower case.

- Each clause must be in parentheses. For example:

(uRoles like '*:contributor:*') and (uUserLocale like 'hq')

B.4.3.3 UserName Variable

The variable UserName is the name of the user who is currently logged in. For example, the following code would grant privileges only to the users jgreen or hbrown.

UserName like 'jgreen|hbrown'

B.4.3.4 stdSecurity Variable

The variable stdSecurity specifies the standard security model; it is mapped to the stdSecurityCheck Idoc Script function. This variable can be used in Boolean combination with other query clauses to refine access (using the and operator) or expand access (using the or operator). For example, the following code would grant access to the document if the user would normally be able to access the document or they are jgreen or hbrown.

stdSecurity or UserName like 'jgreen|hbrown'

B.4.3.5 User Attribute Fields

When specifying user attribute fields in a query, use the format uFieldName. For example:

uMyUserField like 'Value'

B.4.3.6 User Roles

User roles require a special form because the UserRoles Idoc Script function returns all the roles for the current user in comma delimited form. (In this example, a uRoles shortcut has been defined for this function.) For example, the uRoles value could be:

role1,role2,...,role10

Therefore, to specify a query string that includes the value role1, wildcards must be included so that the query will recognize the value regardless of its position in the role list. For example:

uRoles like '*role1*'

However, this query string would also grant security access to a user with the role role10, which might not be a role you want to include. To limit the uRoles value to only those roles specified in the query, you need to use the DelimitedUserRoles function and syntax, which includes single quotes and colons on each side of the role value as follows:

uRoles like '*:role1:*'

To match either role1 or role2, use this syntax:

uRoles like '*:role1:*|*:role2:*'

B.4.4 Defining a Content-Level Query

Use the following procedure to define a query for an individual content item:

1. Display the Content Check In Form page (for a new content item) or the Info Update Form page (for an existing content item).

2. Click the Update button next to the DocDisclosureQuery field (the name of this field will be whatever you named it during installation).
The Disclosure Query Security Applet is displayed.

3. Choose a Field, an Operator, and a Value to create a query clause.

4. Click Add.
The query clause is added to the Query Expression text box.

5. Continue building the query:

- To add another query clause with an and operator, enter the values and click Add.

- To change an existing query clause, enter the new values, select the query line you want to change, and click Update.

- To create an or clause, enter the new values, select the query line you want to change, and click Merge.

- To delete a query clause, select the query line and click Delete.

6. Enter the query expression in the DocDisclosureQuery field.

- To replace the existing query in the DocDisclosureQuery field with the query expression in the applet, click Replace.

- To append the query expression in the applet to the existing query in the DocDisclosureQuery field, click Append.

The Disclosure Query Security applet converts the query clauses to the appropriate syntax for the query and enters the query in the DocDisclosureQuery field on the Content Check In Form or Info Update Form page.

Note:
You can learn how to correctly format query clauses for direct entry in the DocDisclosureQuery field by experimenting with the Disclosure Query Security applet.

7. After filling out the rest of the fields, click Check In or Update.
The disclosure query is validated, and if the query is ill-formed, an error message tells you the specific problem with the query.

B.5 NTK Administration Interface

After the Need to Know component has been installed, the NTK Configuration Information link is available through the Administration tray or menu. This link provides access to the NTK Configuration Information page, which provides security configuration status information and the capability to edit the security configuration.

The Need to Know component provides the following configuration pages:

- "NTK Configuration Information Page"

- "Content Security Configuration Information Page"

- "Search Results Configuration Information Page"

- "Hit List Roles Configuration Information Page"

- "Test NTK Content Security Page"

B.5.1 NTK Configuration Information Page

The NTK Configuration Information page provides information about Need to Know content security configuration, search results configuration, and hit list roles configuration. This page also enables you to edit the security configuration, edit the search results configuration, edit the hit list roles configuration, view Idoc Script and hidden fields for the configuration, and test Idoc Script. To access this page, select Administration, then NTK Configuration Information from the main menu.

Element

Description

Access Level column

Displays the permission levels (Read, Write, Delete) for access to content items.

Enabled column

Indicates whether Need to Know security is enabled for Read, Write, or Delete access.
No: Need to Know security is disabled for the access level. This is the default.

Yes: Need to Know security is enabled for the access level.

Limit Access column

Specifies whether Read, Write, and Delete access is limited by Need to Know security. If Need to Know security is used to limit user access, it does so regardless of whether the user has standard Read, Write, or Delete access to a content item. If Need to Know security is not used to limit user access, the user has standard access to a content item. This feature enables you to create a security model more restrictive than the standard security model.
No: Access is not limited by Need to Know security. This is the default

Yes: Access is limited by Need to Know security.

Script column

Provides links to view or test Idoc Script that is evaluated to determine if a user has Read, Write, or Delete access to a content item. The Need to Know component uses one of three parameters as a flag to determine if access is given:
Read access: isNTKReadAccess

Write access: isNTKWriteAccess

Delete access: isNTKDeleteAccess

Click View in the row for the access level for which you want to view the Idoc Script that the Need to Know component evaluates to determine if a user has Read, Write, or Delete access.

Click Test in the row for the access level for which you want to test the Need to Know security configuration. The NTK Test Content Security page is displayed. You can use this page to create and run a test of Idoc Script for security configuration. For more information, see "Test NTK Content Security Page".

Disclosure Field option

Displays the custom metadata field that is evaluated for the Idoc Script function isDisclosureQuery. The disclosure field can be used to create a content-specific query. The default value is <none>.
Use the Configuration Manager to create this field, and make it a memo field type. For more information, see "Installing the NTK Component" and "Configuring the NTK Component".

When the disclosure field exists, an Update button is displayed next to the field where it appears on the Content Check In Form page. Click the button to access the Disclosure Query Security Applet (see "Disclosure Query Security Applet"). The applet helps you create queries based on the user metadata.

Security Auth Groups option

Displays a list of security groups for which Need to Know security is used. The groups must be a subset of the SpecialAuthGroups configuration variable. If no groups are selected, all SpecialAuthGroups are used. The default value for SpecialAuthGroups is <All Special Auth Groups>.
Use the Configuration Manager to specify a SpecialAuthGroups value in the config.cfg file. For more information, see "Installing the NTK Component" and "Configuring the NTK Component".

Debug option

Displays the status of the debugging option.
Yes: Debugging information is written to a log file for any security check that occurs for a content item. Users with the administrator role are not logged because they always receive access to the content item.

No: Debugging information is not written to a log file.

Edit button

Displays the Content Security Configuration Information page, where the content security configuration can be changed

Hidden Fields field

Click View to display a list of fields that can be hidden on the Search Results page.

Script field

Click View to display the Idoc Script that controls the presentation of the Search Results page.

Edit button

Displays the Search Results Configuration Information page, where the search results security configuration can be changed.

Query Role field

Displays the name of the query role, or <none>. This role is applied on the Search query page.

Update Role field

Displays the name of the update role, or <none>. This role is applied on a content check-in or update page.

Allow Hit List Role for Anonymous Users field

Applies the hit list role for anonymous users.
No: The hit list role is not applied for anonymous users. This is the default value.

Yes: The hit list role is applied for anonymous users.

Edit button

Displays the Hit List Roles Configuration Information page, where the hit list roles security configuration can be changed.

B.5.2 Content Security Configuration Information Page

The Content Security Configuration Information page enables you to change security and access configuration for Read, Write, Delete, and other options for the Need to Know component. To access this page, click Edit in the Content Security Configuration Information area of the NTK Configuration Information page.

Element

Description

Read Options: Use Security list

Use security as specified in the Script field.
No: Do not use Need to Know content security. This is the default value.

Yes: Use Need to Know content security.

Read Options: Limit Access list

Limit access permissions as specified in the Script field.
No: Do not limit access permissions. This is the default value.

Yes: Limit access permissions.

Read Options: Script field

Enter IdocScript in this field to specify the Need do Know security configuration for Read permission.

Write Options: Use Security list

Use security as specified in the Script field.
No: Do not use Need to Know content security. This is the default value.

Yes: Use Need to Know content security.

Write Options: Limit Access list

Limit access permissions as specified in the Script field.
No: Do not limit access permissions. This is the default value.

Yes: Limit access permissions.

Write Options: Script field

Enter IdocScript in this field to specify the Need to Know security configuration for Write permission.

Delete Options: Use Security list

Use security as specified in the Script field.
No: Do not use Need to Know content security. This is the default value.

Yes: Use Need to Know content security.

Delete Options: Limit Access list

Limit access permissions as specified in the Script field.
No: Do not limit access permissions. This is the default value.

Yes: Limit access permissions.

Delet Options: Script field

Enter IdocScript in this field to specify the Need to Know security configuration for Delete permission.

Other Options: Disclosure Field field

Select the name of a disclosure field from the list.This field is used to configure security in a content-specific query.
Note: If you create a metadata field for content item-level queries using the Configuration Manager, that field will appear as an option in the list.

Other Options: Security Auth Groups field

Enter the SpecialAuthGroups to be used in content-specific queries. If you use the General Configuration page to create a specific security group for the Need to Know component, you can specify the group here. If you need to add a security group, you can also edit the Additional Configuration Variables SpecialAuthGroups value in the config.cfg file.

Other Options: All Auth Groups check box

Specifies that the Need to Know component use all SpecialAuthGroups instead of a specific group listed in the Security Auth Groups field. This check box is selected by default.
Note: Other products such as Records Management can also use the SpecialAuthGroups variable. Be careful to specify only the security groups you want to use the Need to Know security configuration.

Other Options: Debug list

Select whether to use debugging to view security checking for a content item.
Yes: Debugging information is written to a log file for any security check that occurs for a content item. Users with the administrator role are not logged because they always receive access to the content item.

When debugging is used, two additional options are visible: View and Clear. Click View to view the log file of debugging information. Click Clear to empty the log file of information.

No: Debugging is not used and information is not written to a log file. This is the default value.

Update button

Updates the content security information to use the new settings, restarts the Content Server, and returns you to the NTK Configuration Information page.

Reset button

Returns the Content Security configuration settings to their last saved values.

B.5.3 Search Results Configuration Information Page

The Search Results Configuration Information page enables you to customize the search results that are returned from a search query. This does not affect what content items are returned, just how the results are displayed. To access this page, click Edit in the Search Results Configuration Information area of the NTK Configuration Information page.

Element

Description

Hidden Fields box

Displays the list of fields that are hidden from view in a content search query result. The values are set to empty strings. These fields are hidden if the field hideFields is set in the search results script.

Available Fields box

Displays the list of fields that are included in a content search query result.

Add button

Select a field name and click Add to move the field from the Available Fields list to the Hidden Fields list, making the field hidden in a content search result.

Remove button

Select a field name and click Remove to move the field from the Hidden Fields list to the Available Fields list, making the field visible in a content search result

Script field

Enter Idoc Script in this field to control the presentation of search results. The Idoc Script is evaluated for each row in the search results. A number of fields can be set to alter the presentation:

- docInfo:enabled: Set to 0 to disable the content information link.

- docInfo:link: Set to alter the content information page link.

- docInfo:image_small: Set to alter the small image for the information link.

- docInfo:image_large: Set to alter the large image for the information link.

- url:enabled: Set to 0 to disable the URL link.

- url:link: Set to alter the URL link.

- url:image: Set to alter the image for the URL link.

- revHistory:enabled: Set to 0 to disable the revision history link.

- revHistory:link: Set to alter the revision history link.

- checkout:enabled: Set to 0 to disable to checkout link.

- checkout:linkF: Set to alter the checkout link.

- actions:enabled: Set to 0 to disable the actions popup link.

- checkInSimilar:enabled: Set to 0 to disable the Check In Similar link.

- email:enabled: Set to 0 to disable the email link.

- dynConv:enabled: Set to 0 to disable the Dynamic Converter link.

Update button

Updates the configuration for search query results, restarts the Content Server, and returns you to the NTK Configuration Information page.

Reset button

Returns the Search Results configuration settings to their last saved values.

B.5.4 Hit List Roles Configuration Information Page

The Hit List Roles Configuration Information page enables you to configure hit list roles for users. To access this page, click Edit in the Hit List Roles Configuration Information area of the NTK Configuration Information page.

Element

Description

Query Role field

Select the hit list role to be applied as the query role when the Search page is used. Security group roles with Read access are displayed in the list of selections, including any security group roles for which the user already has Read access.
This role is separate from content security. You could have a content item appear in Search results configured for content security, but the user would not be able to view the Content Information page for that item.

Update Role field

Select the hit list role to be applied as the update role when the Update page is used. Security group roles with Write access are displayed in the list of selections, including any security group roles for which the user already has Write access. When the content item is actually checked in or updated, this role is not applied.
This field is probably most useful in conjunction with content security. For examples of using this field,see "Security Customization Samples".

Allow Hit List Role for Anonymous Users field

Applies the hit list roles for anonymous users.
No: Do not apply the hit list roles for anonymous users. This is the default value.

Yes: Apply the hit list roles for anonymous users.

Update button

Updates the hit list configuration, restarts the Content Server, and returns you to the NTK Configuration Information page.

Reset button

Returns the Hit List Roles configuration settings to their last saved values.

B.5.5 Test NTK Content Security Page

The Test NTK Content Security page enables you to run a test security script for a user. To access this page, click Test in the Script column for one of the access permission levels displayed on the NTK Configuration Information page.

Element

Description

Access Level field

Displays the access level for the permissions level you select to test: Read, Write, or Delete.

Script field

Enter Idoc Script for the content security configuration to be tested.

User field

Enter the user ID for the test.

Set Attributes check box

Select the check box to automatically set the user attributes to match the user's existing attributes.

Roles field

Enter the roles assigned to the user for the test. Use this field if you are testing with external users where attributes may not be accessible.

Accounts

Enter the accounts assigned to the user for the test. Use this field if you are testing with external users where attributes may not be accessible.

Content ID

Enter the content ID for the test.

Test button

Click Test to test the configuration specified on the Test NTK Content Security page. The Need to Know component test returns results on whether the user has the specified access, whether Need to Know security was used, and if Need to Know security was not used then the reason why.

Reset button

Returns the Test NTK Content Security configuration settings to their last saved values.

B.6 Security Customization Samples

This section contains samples of security model customization.

- "Content Security Samples"

- "Search Result Samples"

- "Hit List Roles Samples"

B.6.1 Content Security Samples

This section contains samples of content security customization:

- "Simple Idoc Script Function"

- "Using stdSecurityCheck"

- "Using isStrIntersect"

- "Using allStrIntersect"

- "Using includeNTKReadSecurityScript"

B.6.1.1 Simple Idoc Script Function

This sample allows Read access if the user Color custom field and the content Color custom field match.

<$if strEquals(uColor, xColor)$><$isNTKReadAccess=1$><$endif$>

B.6.1.2 Using stdSecurityCheck

This sample allows Read access if the user Color is Blue and the user has standard security to the content.

<$if stdSecurityCheck() and strEquals(uColor, "Blue")$><$isNTKReadAccess=1$><$endif$>

B.6.1.3 Using isStrIntersect

This sample returns true because 3 is a member of the first string.

<$if isStrIntersect("1,2,3,4", "5,3")$><$isNTKReadAccess=1$><$endif$>

This sample returns false because neither 5 or 6 is a member of the first string.

<$if isStrIntersect("1,2,3,4", "5,6")$><$isNTKReadAccess=1$><$endif$>

This sample returns false because the second string is empty and the third parameter is not specified.

<$if isStrIntersect("1,2,3,4", "")$><$isNTKReadAccess=1$><$endif$>

This sample returns true because the second string is empty and the third parameter is true.

<$if isStrIntersect("1,2,3,4", "", 1)$><$isNTKReadAccess=1$><$endif$>

This sample returns false because the second string is empty and the third parameter is false. Note that the third parameter can be a string (for example, "True" or "T") or a number (for example, 1, 0).

<$if isStrIntersect("1,2,3,4", "", 0)$><$isNTKReadAccess=1$><$endif$>

B.6.1.4 Using allStrIntersect

This sample returns false because 5 is not a member of the first string.

<$if allStrIntersect("1,2,3,4", "5,3")$><$isNTKReadAccess=1$><$endif$>

This sample returns true because 3 and 4 are members of the first string.

<$if allStrIntersect("1,2,3,4", "3,4")$><$isNTKReadAccess=1$><$endif$>

The samples in Using isStrIntersect (page 4-2) that use the third parameter would work the same with allStrIntersect.

B.6.1.5 Using includeNTKReadSecurityScript

Read script:

<$if strEquals(dDocType, "Document")$><$isNTKReadAccess=1$><$endif$>

Write script:

<$includeNTKReadSecurityScript()$><$if isNTKReadAccess and strEquals(uColor, "Red")$><$isNTKWriteAccess=1$><$endif$>

The user has Write access to the content item if they have read access (type is Document) and the user's Color is Red.

B.6.2 Search Result Samples

This section contains samples of search results customization:

- "Disabling Links"

- "Changing Links"

- "Changing Images"

B.6.2.1 Disabling Links

This sample disables the URL and Content Information link if the user does not have Read access to the content item. This could be used if you set the query role to show extra content items in the search results, but don't want users to see links to them.

<$if not securityCheck()$><$docInfo:enabled=0$><$url:enabled=0$><$endif$>

B.6.2.2 Changing Links

This sample alters the Content Information and URL link to another service if the Color of the content is Red.

<$if strEquals(xColor, "Red")$><$docInfo:link=HttpCgiPath & "?IdcService=GET_USER_INFO"$><$url:link="javascript:alert('Cannot view content.')"$><$endif$>

B.6.2.3 Changing Images

This sample alters the Content Information link if the Color of the content item is Green.

<$if strEquals(xColor, "Green")$><$docInfo:image_small=HttpImagesRoot & "stellent/tree_icons/historical.gif"$><$endif$>

B.6.3 Hit List Roles Samples

This section contains samples of hit list roles customization:

- "Using the Query Hit List Role"

- "Creating a Black Hole Check In"

B.6.3.1 Using the Query Hit List Role

If you set the Query role to be queryRole, and queryRole has Write access to the security group NTKGroup, then NTKGroup will appear in the security group option list. You could then limit what content information appears by customizing the Search Results configuration values

B.6.3.2 Creating a Black Hole Check In

By using the Update role, you could create a scenario where a user could check in a content item and then not be able to view or edit it. You would need to do the following:

1. Create a role called updateRole that has Read/Write access to the security group NTKGroup.

2. Update the Write content security script so that if a meta change is occurring and the security group is NTKGroup, allow access.

<$if isMetaChange and strEquals(dSecurityGroup, "NTKGroup")$><$isNTKWriteAccess=1$><$endif$>

Index
A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Z

Symbols

#env.WeblayoutDir$, 3.5.4.2.2

$dDocAccount$, 3.5.4.2.2

$dDocName$, 3.5.4.2.2

$dDocType$, 3.5.4.2.2

$dSecurityGroup$, 3.5.4.2.2

$dWebExtension$, 3.5.4.2.2

$ExtensionSeparator$, 3.5.4.2.2

$HttpWebRoot$, 3.5.4.2.2

$RenditionSpecifier$, 3.5.4.2.2

$RevisionLabel$, 3.5.4.2.2

@ symbol, accounts, 4.4.1.2

A

about

System Properties, 3.1.1

user information fields, 4.5.3.1

Access Implementor, A.1.4.4 accessing

Content Server Analyzer, 3.10.7.1

account filter

syntax, 4.7.2.3

account prefix, A.1.6.8

depth parameter, A.1.6.8

accounts, 4.1, 4.1.1.2, 4.4.1, 4.4.3.6

@ symbol, 4.4.1.2

assigning to users, 4.4.2.5

case study, 4.4.3

creating during checkin, 4.4.1, 4.4.2.3

creating predefined, 4.4.2.2

enabling, 4.4.2.1

example structure, 4.4.1.2

external directory server, 4.4.1.4

hierarchical, 4.4.1.2

predefined, 4.4.1

prefix, 4.4.1.2

show only known, A.1.2.3.1, A.1.2.3.2

slashes, 4.4.1.2

using, 4.5.1

accounts and roles

matching, 4.7.2.3

AcctPermDelim, A.1.6.8 AcctPrefix, A.1.6.8 Action, A.1.4.1 Action History Screen, A.4.1.10 actions

predefined, A.3.3.4.1

service, A.3.3.4

actions, Batch Loader, 3.9.1.2 Active Directory LDAP provider

adding an, 3.7.2.5

Add Action screen, A.3.3.4 Add Archive screen, A.4.2.3 Add BatchBuilder Mapping Field screen, A.1.8.6 Add BatchBuilder Mapping screen, A.1.8.4, A.1.8.4 Add Component screen, A.3.3.1 Add Dynamic Resource Table Information screen, A.3.3.8 Add HTML Resource Include/String screen, A.3.3.11 Add Intradoc Template screen, A.3.3.21 Add LDAP Provider Page, A.1.6.8 Add New Account screen, A.2.3.3 Add New Alias screen, A.2.4.11 Add New Group screen, A.2.2.2 Add New Predefined Account screen, 4.4.2.1 Add New Role screen, A.2.2.4, A.2.4.7 Add Outgoing Http Provider Page, A.1.6.14 Add Parameter screen, A.3.3.12 Add Partition, A.1.4.1 Add Partition page, A.1.4.2

Capacity Check Interval, A.1.4.2

Duplication Methods, A.1.4.2

Is Active, A.1.4.2

Partition Name, A.1.4.2

Partition Root, A.1.4.2

Reset, A.1.4.2

Slack Bytes, A.1.4.2

Update, A.1.4.2

Add Provider page, A.1.6.3 Add Query screen, A.3.3.13 Add Query Table Information screen, A.3.3.6 Add Resource Definition screen, A.3.3.14 Add screen

Component Wizard, A.3.3.5

Add SearchResults Template screen, A.3.3.19 Add Service screen, A.3.3.16 Add Service Table Information screen, A.3.3.7 Add Static Resource Table Information screen, A.3.3.9 Add Storage Rule page, A.1.4.5 Add Template Table Information screen, A.3.3.10 Add User

Accounts tab, A.2.4.8

Info tab

global user, A.2.4.5

local user, A.2.4.3

Roles tab, A.2.4.6 Add User screen, A.2.4.3 Add/Edit Batch Builder Mapping Field, A.1.8.6 adding

database providers, 3.7.1.2.2

existing components, 5.3.3.8

incoming providers, 3.7.1.2.3

LDAP providers, 3.7.1.2.5

outgoing providers, 3.7.1.2.1

preview providers, 3.7.1.2.4

provider

database, 3.7.2.2

incoming, 3.7.2.3

outgoing, 3.7.2.1

preview, 3.7.2.4

providers, 3.7.1.2 redirect in Batch Loader, 3.9.3.7 security groups, 4.3.2.1 user information fields, 4.5.3.2.1 users, 4.5.2.1 Additional Configuration Variables field, A.1.2.2.1, A.1.2.2.2 Admin Actions page, A.1.3.11 Admin Applets page, 1.4.3 Admin permission, 4.3.3.3, A.2.2.5 admin role, 4.3.3.1 Admin Server

about, 3.2.1

Additional Configuration Variables field, A.1.2.2.1, A.1.2.2.2

Content Security page, A.1.2.3.2

enabling and disabling components, 5.2.1

General Configuration page, A.1.2.2.2

home page, A.1.1.1

Internet Configuration page, A.1.2.4.2

Output page, A.1.1.3

Server Status page, A.1.1.2

uploading components, 5.2.3

Administration

tray, 1.4.2

administration

applications as applets, 1.5.1

applications in standalone mode, 1.5.2

interfaces, 1.4.1

launching applications, 1.5

management pages, 1.4.1.2

tools, 1.3

utilities, 1.4.1.1

administration applications

running as applets, 1.5.1

Administration page, A.1.1.4 administrator, 1.1

responsibilities, 1.2

role, 1.2

setting up sub, 4.5.3

Administrator Mail Address, A.1.2.4.1, A.1.2.4.2 Advanced Component Manager page, A.3.6 alias

creating, 4.5.2.4

Allow author to delete revision, A.1.2.3.1, A.1.2.3.2 Allow get copy for user with read privilege, A.1.2.3.1, A.1.2.3.2 Allow only original contributor to check out, A.1.2.3.1, A.1.2.3.2 AllowArchiveNoneFolderItem variable, 7.11.3.4 AllowMigrationOfParentFoldersMeta variable, 7.11.3.4 AllowMultiple

column description, 3.4.6.8.8

analysis

Content Server Analyzer database, 3.10.7.4

Content Server Analyzer file system, 3.10.7.6

Content Server Analyzer search index, 3.10.7.5

starting Content Server Analyzer, 3.10.7.3

Analyzer, 3.10.6, A.1.9.1 AppletChunkSize, 3.1.2.6 AppletChunkThreshold, 3.1.2.6 applets, running applications, 1.5.1 applet-specific tracing, 3.10.4.2 applications

launching administration, 1.5, 1.5

running as applets, 1.5.1

running in stand-alone mode, 1.5.2

Archive Collections screen, A.4.6.3 archive comparison, 7.2.6 archive replication, 4.7.1 archive, local, 7.7.1.3 archive, proxied, 7.7.1.3 archive, targetable, 7.7.1.3 ArchiveFolderStructureOnly variable, 7.11.3.4 Archiver, 3.7.1.2.1, 3.7.1.2.3, 7.8

application, 1.4.1.3

automating export, 7.8.2.1

automation, 7.8.1

batch files, 7.4.1.3

copying archives, 7.4.2.3

creating collections, 7.4.1.2, 7.4.3.2

creating export queries, 7.5.2.2

defining sockets as providers, 7.7.4.3

examples, 7.9.7.1, 7.9.7.2, 7.9.7.3

exporting user interface, 7.5.1

log files, 3.10.1.2, 3.10.1.4

logs, 7.4.1.5

moving default collection, 7.4.3.4

opening collections, 7.4.3.1

removing collections, 7.4.3.3

removing files from batch file, 7.4.4.1

replicating import on import machine, 7.8.2.2

replication, 7.8.1

Replication tab, A.4.5.1

setting export options, 7.5.2.7

setting import options, 7.6.3.4

setting transfer destination (target), 7.7.4.4

specifying file to retrieve, 7.6.3.5

transfer rules, 7.7.3

transferring batch files to different archive, 7.7.4.5

understanding components, 7.4.1.1

understanding how batch files are read, 7.7.3

understanding logs, 7.4.1.5

what you can archive, 7.4.1.4

Archiver utility, 7.11.3.3 ArchiverReplicationExceptons

overview, 7.2.5, 7.12.1

archives

copying, 7.4.2.3

making targetable, 7.7.4.2

moving default collection, 7.4.3.4

transferring batch files, 7.7.4.5

archives, see folder structure archives, 7.11.3.1 archiving, 7.8

folders, 7.2.3

archiving differences between Folders and Folder Structure Archive, 7.11.2 archiving folder content, 7.2.4 archiving issues

exporting issues, 7.13.2

importing issues, 7.13.1

miscellaneous issues, 7.13.7

Oracle-specific issues, 7.13.6

replication issues, 7.13.5

transfer issues, 7.13.3

WebDAV issues, 7.13.4

archiving process, 7.5.2.1 ArgumentFields, 3.5.3.3 Arguments, 3.5.3.3 assigning

accounts, 4.4.2.5

roles, 4.3.4.3

assigning Optimized Fields, 6.1.4.2 AttributeMap, A.1.6.8 attributes

LDAP, A.1.6.8

authentication

LDAP, 4.2.1

author, allowing delete, A.1.2.3.1, A.1.2.3.2 AuthorDelete, A.1.2.3.1, A.1.2.3.2 authorization type, 4.5.2.1, A.2.4.2 AutoCreateLimit, 3.5.3.4 automated archiving, 7.8.1 automatic Content ID, A.1.2.2.1, A.1.2.2.2 automatic update cycle, A.1.3.1 Automatic Update Cycle screen, A.1.3.2 Automatic Update Cycle status and actions, A.1.3.11 AutoNumberPrefix, A.1.2.2.1, A.1.2.2.2

B

BASE_JAVA_CLASSPATH_custom, A.1.2.7

batch load files

Archiver, 7.4.1.3

case sensitivity, 3.9.1.1

creating from BatchBuilder screen, 3.9.2.3

creating from command line, 3.9.2.5

file records, 3.9.1.1

preparing, 3.9.2, 3.9.2.1

removing archive files, 7.4.4.1

samples, 3.9.2

transferring to different archive, 7.7.4.5

understanding Archiver, 7.7.3

Batch Loader, 3.9, 3.9.1

actions, 3.9.1.2

adding a redirect, 3.9.3.7

command line example, 3.9.3.6.1

-console switch, 3.9.3.6

delete action, 3.9.1.4

file records, 3.9.1.1

insert action, 3.9.1.3

interface, A.1.8.1

mapping file, 3.9.2.2

optional parameters, 3.9.1.6

preparing batch load files, 3.9.2

running, 3.9.3, 3.9.3.1

UNIX example, 3.9.3.3.2

update action, 3.9.1.5

utility, 1.4.1.1

Win32 example, 3.9.3.3.1

Batch Loader screen, A.1.8.1

batch loading, 3.9.3.2

batch loading, 3.9, 3.9.1

correcting errors, 3.9.3.8

custom metadata fields, 3.9.1.7

from Batch Loader screen, 3.9.3.2

from command line, 3.9.3.3

interface, A.1.8

BatchBuilder, 3.9.2.1

creating mapping file, 3.9.2.4

UNIX example, 3.9.2.5.2

Win32 example, 3.9.2.5.1

BatchBuilder Mapping List screen, A.1.8.3 BatchBuilder screen, A.1.8.2, A.1.8.2

creating batch load file, 3.9.2.3

Browse for Fields screen, A.4.4.4 Browse for Proxied Collection screen, A.4.2.8 Browse Local screen, A.4.2.6 Browser Executable Path, A.1.2.7 Build menu, A.3.2.2 Build screen, A.3.4.2 build settings, 5.3.3.1 Build Settings screen, A.3.4.3 build settings, component, A.3.2.2 building, A.3.4.2

component Zip file, 5.3.3.1

components, A.3.4.2, A.3.4.3

building installation settings, A.3.4.3 bundle, 7.2.1 bundle subdirectory, 7.3.1.1 bundles

importing, 7.3.3.7

uploading, 7.3.3.6

C

canceling

Content Server Analyzer status report, 3.10.7.9

Capacity Check Interval, A.1.4.2 CapacityCheckInterval, 3.5.3.1 case study, accounts, 4.4.3 Change the Authorization Type Screen, A.2.4.2 checkin

creating accounts, 4.4.2.3

checkout

only original contributor, A.1.2.3.1, A.1.2.3.2

Choose the Authorization Type Screen, A.2.4.2 Choose the Authorization Type screen, A.2.4.2 ChunkedRequestTrace, 3.1.2.6 Chunking function, 3.1.2.5 CLASSPATH, A.1.2.7 collection

local, 7.7.1.3

proxied, 7.7.1.3

collection IDs, 7.11.3.4 collection rebuild cycle, A.1.3.1 Collection Rebuild Cycle status and actions, A.1.3.11 CollectionIsConsumptionOnly variables, 7.11.3.4 collections

creating archive, 7.4.1.2, 7.4.3.2

moving default archive, 7.4.3.4

opening archive, 7.4.3.1

rebuilding search, 3.4.2.3

removing archive, 7.4.3.3

Column

column description, 3.4.6.8.3

Column Information screen, A.3.3.20 ColumnTranslation table, A.3.3.9.1 combining security integration methods, 4.1.1.3 command line

Batch Loader, 3.9.3.6

Batch Loader example, 3.9.3.6.1

batch loading, 3.9.3.3

creating batch load file, 3.9.2.5

running Idoc Script, 1.4.1.4

comparing archive types, 7.2.6 component

creating with Component Wizard, 5.3.2

Component Configuration screen, A.3.3.3 Component List screen, A.3.1 Component Manager, 5.2

using, 5.2

Component Manager page, A.3.5 Component Wizard, 5.2, 5.3.3.1

Add Action screen, A.3.3.4

Add Dynamic Resource Table Information screen, A.3.3.8

Add HTML Resource Include/String screen, A.3.3.11

Add Intradoc Template screen, A.3.3.21

Add Parameter screen, A.3.3.12

Add Query screen, A.3.3.13

Add Query Table Information screen, A.3.3.6

Add Resource Definition screen, A.3.3.14

Add screen, A.3.3.5

Add SearchResults Template screen, A.3.3.19

Add Service screen, A.3.3.16

Add Service Table Information screen, A.3.3.7

Add Static Resource Table Information screen, A.3.3.9

Add Template Table Information screen, A.3.3.10

adding existing components, 5.3.3.8

Build menu, A.3.2.2

Build screen, A.3.4.2

Build Settings screen, A.3.4.3

Column Information screen, A.3.3.20

configuring default HTML editor, 5.3.3.6

creating a new component, 5.3.1

creating component example, 5.3.2

creating HTML includes, 5.3.2.6

creating static tables, 5.3.2.8

Edit Action screen, A.3.3.4

Edit HTML Resource Include/String screen, A.3.3.11

Edit Intradoc Template screen, A.3.3.21

Edit Parameter screen, A.3.3.12

Edit Query screen, A.3.3.13

Edit SearchResults Template screen, A.3.3.19

Edit Service screen, A.3.3.16

editing the Readme file., 5.3.1.2

enabling and disabling components, 5.3.3.3

Help menu, A.3.2.3

Java code tab, 5.3.1.1

opening components, 5.3.3.5

Options menu, A.3.2.1

removing components, 5.3.3.4

Resource Selection Dialog screens, A.3.3.15

unpackaging components, 5.3.3.7

using, 5, 5.3

working with resources, 5.3.1.1

component Zip file

building, 5.3.3.1

components, 5.2

adding existing, 5.3.3.8

build settings, A.3.2.2

building, A.3.4.2, A.3.4.3

creating, 5.3.1

disabling, 5.2.1, 5.3.3.3

enabling, 5.2.1, 5.3.3.3

opening, 5.3.3.5

removing, 5.3.3.4

unpackaging, 5.3.3.7

uploading, 5.2.3

ComponentTool

utility, 1.4.1.1

ComponentWizard

utility, 1.4.1.1

config.cfg file, A.1.2.2.1, A.1.2.2.2 configuration bundles, 7.2.1 Configuration Bundles Screen, A.4.1.3 Configuration Class, A.1.4.4, A.1.6.8 configuration export, 7.3.3.5 configuration information, 3.10.2 Configuration Manager

application, 1.4.1.3

Configuration Migration

bundles, 7.3.1.2

configuration export, 7.3.3.5

creating templates, 7.3.3.1

downloading bundles, 7.3.3.8

editing templates, 7.3.3.2

importing bundles, 7.3.3.7

importing templates, 7.3.3.3

one-time exports, 7.3.3.4

overview, 7.3

status information, 7.3.3.9

templates, 7.3.1.2

tips, 7.3.2

uploading bundles, 7.3.3.6

Configuration Migration Admin Screen, A.4.1.5 configuration template

editing, 7.3.3.2

configuration templates, 7.2.1 Configuration Templates Screen, A.4.1.4 configuration variable

DefaultAttributesCacheTimeoutInSeconds, 4.8.3.2

configuration variables, 3.5.2.1, 3.10.8

AllowArchiveNoneFolderItem, 7.11.3.4

AllowMigrationOfParentFoldersMeta, 7.11.3.4

ArchiveFolderStructureOnly, 7.11.3.4

CollectionIsConsumptionOnly, 7.11.3.4

for Folder Structure Archive component, 7.11.3.4

for Folders component, 7.11.3.4

Configure Automatic Update Cycle screen, A.1.3.2 Configure Collection Rebuild Cycle screen, A.1.3.3, A.1.3.3 Configure Web Server Filter page, A.1.5.1 configuring

content security, 3.1.3

content server, 3.1.6

database, 3.1.5

database store, 3.5.4.4, 3.5.4.4

default HTML editor, 5.3.3.6

general options, 3.1.2

Internet information, 3.1.4

optional web store, 3.5.4.3

paths, 3.1.8

search collection rebuild, 3.4.2.4

search index update, 3.4.2.4

standard file paths, 3.5.4.2

webless store, 3.5.4.3

Connection Class, A.1.4.4, A.1.6.8 connection string, JDBC, A.1.2.5 Connection timeout, A.1.6.8 -console switch

Batch Loader, 3.9.3.6

consumers, 1.1 content

transferring, 7.7.1

Content Analzyer

utility, 1.4.1.1

Content Categorizer, 3.7.1.2.4 Content Publisher, 3.7.1.2.4 Content Satisfying the Export Query screen, A.4.3.5 content security

Idoc Script functions, B.4.1.1, B.4.1.1

content security options, System Properties, 3.1.3 Content Server

log files, 3.10.1.2, 3.10.1.3

content server

applications, 1.4.1.3

configuring, 3.1.6

purpose, 1.1

restarting, 3.3.3

running, 1.5

running on Windows, 1.5, 1.5

starting, 3.3.1

stopping, 3.3.2

viewing output, 3.2.2

Content Server Analyzer

accessing, 3.10.7.1

canceling status report, 3.10.7.9

console display area, 3.10.7.7

database analysis, 3.10.7.4

file system analysis, 3.10.7.6

Progress tab, A.1.9.2

results, 3.10.7.7

search index analysis, 3.10.7.5

specifying log directory, 3.10.7.2

starting analysis, 3.10.7.3

status report, 3.10.7.8

Content Server analyzer, 3.10.6, A.1.9.1 Content Server Options, 3.5.2.1.2 Content Server Pages

Add Storage Rule page, A.1.4.5

Edit File Store Provider page, A.1.4.4

Edit Partition page, A.1.4.2

Partition Listing page, A.1.4.1

Provider Information page, A.1.4.3

Content Server Sections, A.4.1.6 Content Tracker, 3.7.1.2.5 contributor role, 4.3.3.1 contributors, 1.1 Copy Archive screen, A.4.2.4 copying archives, 7.4.2.3 correcting batch load errors, 3.9.3.8 creating

accounts during checkin, 4.4.2.3

aliases, 4.5.2.4

archive collections, 7.4.1.2, 7.4.3.2

batch load files

from BatchBuilder screen, 3.9.2.3

from command line, 3.9.2.5

export queries, 7.5.2.2 mapping file, 3.9.2.4 new component, 5.3.1 predefined accounts, 4.4.2.2 providers

database, 3.7.2.2

incoming, 3.7.2.3

outgoing, 3.7.2.1

preview, 3.7.2.4

security groups, 4.3.2.1 static table, 5.3.2.8 creating folder structure archives, 7.11.3.1 creating migration templates, 7.3.3.1 credential maps

creating, 4.7.2.4

matching accounts and roles, 4.7.2.3

overview, 4.7.2

values, 4.7.2.2

when to specify, 4.7.2.1

Credential Maps page, A.2.5.1 custom metadata fields, batch loading, 3.9.1.7, 3.9.1.7 custom resources, 5.3.1.1

D

data input

filtering, 4.8.4

Data Provider page, A.1.6.5 database, A.1.2.5

Content Server Analyzer analysis, 3.10.7.4

database access, 4.1.3 Database Options, 3.5.2.1.1 Database options

FsCacheThreshold, 3.5.2.1.1

FsMaximumFileCacheAge, 3.5.2.1.1

FsMinimumFileCacheAge, 3.5.2.1.1

database options, System Properties, 3.1.5 Database provider, 3.7.1.1 database provider

adding, 3.7.1.2.2, 3.7.2.2

Database Provider page, A.1.6.5 database tables

FileCache table, 3.5.3.7

FileStorage table, 3.5.3.6

DatabasePreserveCase, A.1.2.5 databases

used with Oracle Text, 6.1.1

DataSources table, A.3.3.9.1 debug level, Indexer, A.1.3.2, A.1.3.3 debugging, 3.10.4, 3.10.8 default archive collection, moving, 7.4.3.4 default capacity algorithm

characteristic of hint cache, 3.4.6.10.3

default HTML editor, configuring, 5.3.3.6 default optimized fields, 6.1.4.1 DefaultFileStore provider, 3.7.1.1 DefaultNetworkAccounts, A.1.6.8 define user information, A.2.4.3 defining

revision labels, A.1.2.2.1, A.1.2.2.2

sockets as providers, 7.7.4.3

delete

allowing authors permission, A.1.2.3.1, A.1.2.3.2

delete action, 3.9.1.4

example, 3.9.1.4.2

requirements, 3.9.1.4.1

Delete permission, 4.3.3.3, A.2.2.5 deleted folders, 7.11.3.4, 7.11.4 deleting

providers, 3.7.2.9

roles, 4.3.4.2

security groups, 4.3.2.2

users, 4.5.2.3

dEmail, 4.5.3.1 depth parameter, A.1.6.8, A.1.6.8 Descriptor Implementor, A.1.4.4 dFullName, 4.5.3.1 differences with Folders archiving features, 7.11.2 directory

specifying Content Server Analyzer log, 3.10.7.2

directory servers, external, 4.4.1.4 Disabled

column description, 3.4.6.8.9

DisableHttpUploadChunking, 3.1.2.6 disabling

component, 5.2.1, 5.3.3.3

download applet, A.1.2.2.1, A.1.2.2.2

full-text indexing, 3.4.2.5

JSP support, A.1.2.2.1, A.1.2.2.2, A.1.2.6

keyword highlighting, A.1.2.2.1, A.1.2.2.2

displaying categories in search results, 6.1.6 DownloadApplet, A.1.2.2.1, A.1.2.2.2 driver, JDBC, A.1.2.5 Duplication Methods, A.1.4.2 DuplicationMethods, 3.5.3.1 dUserLocale, 4.5.3.1 dUserType, 4.5.3.1 dynamic resource tables, A.3.3.8, A.3.3.8.1, A.3.3.20

E

Edit Action screen, A.3.3.4

Edit Alias screen, A.2.4.11

Edit BatchBuilder Mapping Field screen, A.1.8.6

Edit BatchBuilder Mapping screen, A.1.8.5

Edit BatchBuilding Mapping screen, A.1.8.5

Edit Export Options screen, A.4.3.4

Edit Export Query screen, A.4.3.3

Edit Export Rule Screen, A.4.1.8

Edit Field Maps screen, A.4.4.3

Edit File Store Provider page, A.1.4.4

Access Implementor, A.1.4.4

Configuration Class, A.1.4.4

Connection Class, A.1.4.4

Descriptor Implementor, A.1.4.4

Edit Rule, A.1.4.4

Event Implementor, A.1.4.4

Metadata Implementor, A.1.4.4

Provider Class, A.1.4.4

Provider Description, A.1.4.4

Provider Name, A.1.4.4

Storage Rules, A.1.4.4

Edit HTML Resource Include/String screen, A.3.3.11 Edit Import Options screen, A.4.4.7 Edit Intradoc Template screen, A.3.3.21 Edit LDAP Provider Page, A.1.6.8 Edit Outgoing Http Provider page, A.1.6.14 Edit Parameter screen, A.3.3.12 Edit Partition page, A.1.4.2 Edit Permission screen, A.2.2.5 Edit Permissions for Account screen, 4.4.3 Edit Provider page, A.1.6.3 Edit Query Hint Rules Table, 3.4.6.9, A.1.3.8 Edit Query screen, A.3.3.13, A.3.3.13 Edit Rule, A.1.4.4 Edit SearchResults Template screen, A.3.3.19 Edit Service screen, A.3.3.16, A.3.3.16 Edit Storage Rule page, A.1.4.5

File system only, A.1.4.5

Is Webless File Store, A.1.4.5

JDBC Storage, A.1.4.5

Renditions, A.1.4.5

Show Path Metadata, A.1.4.5

Vault Path, A.1.4.5

Web URL File Path, A.1.4.5

Web-viewable Path, A.1.4.5

Edit User

Accounts tab, A.2.4.8

Info tab

global user, A.2.4.5

local user, A.2.4.3

Roles tab, A.2.4.6 Edit User screen, A.2.4.3 editing

option list keys, 4.5.3.2.2

provider information, 3.7.2.8

Readme file, 5.3.1.2

user information fields, 4.5.3.2.3

users, 4.5.2.2

Editing a Storage Rule

procedure, 3.5.2.2.4

editing Optimized Fields, 6.1.4.2 E-mail Address user field, 4.5.3.1 e-mail address, system administrator, A.1.2.4.1, A.1.2.4.2 e-mail port, A.1.2.4.2 EnableDocumentHighlight, A.1.2.2.1, A.1.2.2.2 enabling

accounts, 4.4.2.1

components, 5.2.1, 5.3.3.3

JSP support, A.1.2.2.1, A.1.2.2.2, A.1.2.6

keyword highlighting, A.1.2.2.1, A.1.2.2.2

Enterprise Search

enabling and disabling, A.1.2.2.1, A.1.2.2.2

EnterpriseSearchAsDefault, A.1.2.2.1, A.1.2.2.2 environment packager, 3.10.5 error information, 3.10 error messages

content server, A.1.1.3

errors

correcting batch load, 3.9.3.8

Event Implementor, A.1.4.4 example

creating component, 5.3.2

database store, 3.5.4.4, 3.5.4.4

optional web store, 3.5.4.3

PathMetaData table, 3.5.4.1

standard file paths, 3.5.4.2

webless store, 3.5.4.3

examples

account structure, 4.4.1.2

accounts, 4.4.3

Archiver, 7.9.7.1, 7.9.7.2, 7.9.7.3

batch load file record, 3.9.1.1

batch load files, 3.9.2

Batch Loader, 3.9.3.6.1

delete action, 3.9.1.4.2

insert action, 3.9.1.3.2

on UNIX, 3.9.3.3.2

on Win32, 3.9.3.3.1

update action, 3.9.1.5.2, 3.9.1.5.3

BatchBuilder

on UNIX, 3.9.2.5.2

on Win32, 3.9.2.5.1

ExclusiveCheckout, A.1.2.3.1, A.1.2.3.2 existing component, adding, 5.3.3.8 export

automatic, 7.8.2.1

creating queries, 7.5.2.2

initiating, 7.5.2.8

setting options, 7.5.2.7

user interface, 7.5.1

Export Archive screen, A.4.3.10 export_opt, 7.5.2.7 exporting configurations, 7.3.3.5 exporting folder hierarchies, 7.10.2 exporting issues (Archiver), 7.13.2 Extended User Attributes component

purpose, Preface, Preface, 4.8.3

external authentication provider, 4.2.1 external collections, 3.9.2.1

read-only, 3.9.2.3

external directory server considerations, 4.4.1.4 external users, 4.1.2.1, 4.1.2.1 ExtranetLook component, 4.8.1 ExtUserAttribInfo resultset, 4.8.3.1

F

farm, 1.3.1

fast rebuild

overview, 6.1.4.3

when to perform, 6.1.4.3

Fast Rebuild screen, A.1.3.4 features, 7.11 FieldName, 3.5.3.3 fields

adding user information fields, 4.5.3.2.1

Archiver mapping, 7.6.3.2

custom metadata, 3.9.1.7

editing, 4.5.3.2.3

user information, 4.5.3

file limits, 3.5.4.5.2 file records, 3.9.1.1

example, 3.9.1.1

File Storage Provider Interface, A.1.4 file system

Content Server Analyzer analysis, 3.10.7.6

files

Readme, 5.3.1.2

FileStorage, 3.5.3.2 FileStore, 3.5.3.4 filter data input, 4.8.4 filters

for matching accounts and roles, 4.7.2.3

rules, 4.7.3.2

folder archiving, 7.2.3 folder archiving component, 7.2.4 Folder Structure Archive component

configuration variables, 7.11.3.4

differences with Folders archiving features, 7.11.2

features, 7.11

implementation considerations, 7.11.4

overview, 7.11

process, 7.11.2

usage, 7.11.1

folder structure archives

creating --, 7.11.3.1

location, 7.11.3.3

updating --, 7.11.3.2

using --, 7.11.3.3

Folders component

archiving features, 7.11.2

InitialColID setting, 7.11.3.4

FolderStructureArchive component, 7.2.4 formats

mapping file, 3.9.2.2.1

FsCacheThreshold, 3.5.2.1.1 FsMaximumFileCacheAge, 3.5.2.1.1 FsMinimumFileCacheAge, 3.5.2.1.1 full group names

LDAP, A.1.6.8

Full Name user field, 4.5.3.1 full-text indexing

disabling, 3.4.2.5

large documents, 3.4.3

Outside In Content Access conversion, 3.4.3

G

general options, System Properties, 3.1.2

generating

Content Server Analyzer status report, 3.10.7.8

GenerationAlgorithm, 3.5.3.3 get copy permission, A.1.2.3.1, A.1.2.3.2 GetCopyAccess, A.1.2.3.1, A.1.2.3.2 group by

supported sort construct, 3.4.6.6

guest role, 4.3.3.1

H

Help menu, A.3.2.3

hierarchical accounts, 4.4.1.2

hint cache

default capacity algorithm, 3.4.6.10.3

managing entries, 3.4.6.10.2

origin of keys, 3.4.6.10.4

overview, 3.4.6.10

persistence, 3.4.6.10.5

reusing entries, 3.4.6.10.1

Hint Cache Updater page, A.1.3.10

accessing, 3.4.6.13.1

checking hint cache for hints

data source, 3.4.6.13.2

modifyng data source or query entry

data source, 3.4.6.13.4

removing data source or query entry

data source, 3.4.6.13.6

Hint Rule Editor, 3.4.6.9, A.1.3.8 hint rules

adding and enabling, 3.4.6.11.1

Hint Rules Configuration page, A.1.3.7

accessing, 3.4.6.11

adding and enabling new hint rules, 3.4.6.11.1

disabling hint rules

hint rules, 3.4.6.11.3

editing hint rules

hint rules, 3.4.6.11.2

enabling hint rules

hint rules, 3.4.6.11.4

overview, A.1.3.7 removing hint rules

hint rules, 3.4.6.11.5

hint rules table

AllowMultiple - column description, 3.4.6.8.8

Column - column description, 3.4.6.8.3

Disabled - column description, 3.4.6.8.9

explanations of rules, 3.4.6.7

Index - column description, 3.4.6.8.5

Key - column description, 3.4.6.8.1

on Hint Rules Configuration page, A.1.3.7

Operators - column description, 3.4.6.8.4

Order - column description, 3.4.6.8.6

overview, 3.4.6.7

Table - column description, 3.4.6.8.2

Values - column description, 3.4.6.8.7

hit list role

configuring roles, B.5.4

Hit List Roles Configuration Information page, B.5.4 HTML

filtering data input, 4.8.4

HTML editor, configuring default, 5.3.3.6 HTML Preview, 3.7.1.1, 3.7.1.2.4, 3.7.1.2.4 HTTP filter, 4.7.3.1 HTTP protocol, 4.7.4 HTTP provider, 3.7.1.1

chunking, 3.1.2.5

configuring, 4.7.4.2

Http Relative Web Root, A.1.2.4.1, A.1.2.4.2 HTTP Server Address, A.1.2.4.1, A.1.2.4.2 httpoutgoing provider

about, 4.7.4.1

HttpRelativeWebRoot, A.1.2.4.1, A.1.2.4.2 HTTPS protocol, 4.7.4 HttpServerAddress, A.1.2.4.1, A.1.2.4.2

I

IdcHomeDir, A.1.2.7

IdcShell component, 1.4.1.4

Idoc Script functions, B.4.1.1, B.4.1.1

content security, B.4.1.1

IdocScriptExtensions table, A.3.3.9.1 IgnoredFlexFields table, A.3.3.8.1 implementation considerations, 7.11.4 import

initiating, 7.6.3.6

setting options, 7.6.3.4

Import Archive screen, A.4.4.8 import machine

replicating import, 7.8.2.2

import rules, 7.6.2, 7.6.2.1 importing bundles, 7.3.3.7 importing issues (Archiver), 7.13.1 importing templates, 7.3.3.3 Inbound Refinery

log files, 3.10.1.2, 3.10.1.5

include resources

adding, A.3.3.11

editing, A.3.3.11

Incoming provider, 3.7.1.1 Incoming Provider page, A.1.6.6, A.1.6.6 incoming provider, adding, 3.7.1.2.3, 3.7.2.3 Index

column description, 3.4.6.8.5

index

updating, 3.4.2.2

Index Fast Rebuild

performing, 6.1.4.3

index fast rebuild

when to perform, 6.1.4.3

Indexer

automatic update cycle, A.1.3.1

collection rebuild cycle, A.1.3.1

debug level, A.1.3.2, A.1.3.3

state, A.1.3.1

status, A.1.3.1

Indexer Rebuild screen, A.1.3.4 indexing, 3.4

disabling full-text, 3.4.2.5

information fields

user, 4.5.3

Informix, A.1.2.5 initial collection ID, 7.11.3.4 InitialColID setting for Folders, 7.11.3.4 initiating

export, 7.5.2.8

import, 7.6.3.6

inner join

supported sort construct, 3.4.6.6

insert action, 3.9.1.3

example, 3.9.1.3.2

requirements, 3.9.1.3.1

Install screen (component), A.3.3.2 Instance Description, A.1.2.6 Instance Menu Label, A.1.2.6 InstanceDescription, A.1.2.6 InstanceMenuLabel, A.1.2.6 internal security, 4.1.1.2 Internet options

System Properties, 3.1.4

Intradoc template, A.3.3.21 IntradocReports table, A.3.3.9.1 IntradocTemplates table, A.3.3.10.1 IP Address Filter, A.1.2.6 Is Active, A.1.4.1, A.1.4.2 Is Webless File Store, A.1.4.5 IsActive, 3.5.3.1 IsAutoNumber, A.1.2.2.1, A.1.2.2.2 IsJdbc, A.1.2.5 IsJspServerEnabled, A.1.2.2.1, A.1.2.2.2, A.1.2.6 IsOverrideFormat, A.1.2.2.1, A.1.2.2.2 IsWeblessStore, 3.5.3.2

J

Java applets, 1.5.1

Java Classpath, A.1.2.7

Java code, 5.3.1.1

JDBC, 3.1.5, A.1.2.5

JDBC Connection String, A.1.2.5

JDBC Driver Name, A.1.2.5

JDBC Storage, A.1.4.5

JDBC User Name, A.1.2.5

JDBC User Password, A.1.2.5

JdbcConnectionString, A.1.2.5

JdbcDriver, A.1.2.5

JdbcPassword, A.1.2.5

JdbcStorage, 3.5.3.2

JdbcUser, A.1.2.5

Jps User provider, 3.7.1.1

JpsUserProvider component, 3.7.1.1

JSP

security groups enabled for, A.1.2.2.1, A.1.2.2.2, A.1.2.6

JSP support, enabling and disabling, A.1.2.2.1, A.1.2.2.2, A.1.2.6 JspEnabledGroups, A.1.2.2.1, A.1.2.2.2, A.1.2.6

K

Key

column description, 3.4.6.8.1

keys

origin of - characteristic of hint cache, 3.4.6.10.4

keyword highlighting, A.1.2.2.1, A.1.2.2.2 known accounts, A.1.2.3.1, A.1.2.3.2

L

label sequence, revision, 3.1.2.1

Latest Action Screen, A.4.1.9

launching administration applications, 1.5

LDAP, 4.2.1

provider, A.1.6.8

LDAP Attribute, A.1.6.8 LDAP provider, 3.7.1.1 LDAP Provider Page, A.1.6.8 LDAP Provider page, A.1.6.8 LDAP provider page, A.1.6.13 LDAP provider, adding, 3.7.1.2.5 LdapAdminDN, A.1.6.8 LdapAdminPassword, A.1.6.8 LdapPort, A.1.6.8 LdapServer, A.1.6.8 LdapSuffix, A.1.6.8 list key, editing, 4.5.3.2.2 local archive, 7.7.1.3 local collection, 7.7.1.3 local transfer, 7.7.1.3, 7.7.2.1 local users, 4.1.2.2 locale, system, A.1.2.6 Localization Indexing status and actions, A.1.3.11 log files

accessing --, 3.10.1.2

accessing Archiver log, 3.10.1.4

accessing Content Server, 3.10.1.2

Archiver, 3.10.1.2, 3.10.1.4

characteristics, 3.10.1.1

configuration migration, 7.3.2.2

Content Server, 3.10.1.2, 3.10.1.3

Inbound Refinery, 3.10.1.2, 3.10.1.5

overview, 3.10.1

verbose logging, 3.10.1

Log Files folder, 3.10.1.2 logins

deleting user, 4.5.2.3

editing user, 4.5.2.2

logout

customizing, 4.8.1

logs

Archiver, 7.4.1.5

specifying directory for Content Server Analyzer, 3.10.7.2

understanding Archiver, 7.4.1.5

M

Mail Server, A.1.2.4.1, A.1.2.4.2

MailServer, A.1.2.4.1, A.1.2.4.2

major revision label, A.1.2.2.1, A.1.2.2.2

major revision label sequence, 3.1.2.1, 3.1.2.1

MajorRevSeq, A.1.2.2.1, A.1.2.2.2

making an archive targetable, 7.7.4.2

managing hint cache entries

characteristic of hint cache, 3.4.6.10.2

manifest path, A.3.4.2 manifest.hda, A.3.4.2 mapping fields, Archiver, 7.6.3.2 mapping files

Batch Loader, 3.9.2.2

creating, 3.9.2.4

formats, 3.9.2.2.1

values, 3.9.2.2.2

mapping values, Archiver, 7.6.3.3 maximum number of fields to optimize, 6.1.4.1 metadata field

xPartitionId, 3.5.2.1.2

xStorageRule, 3.5.2.1.2

xWebFlag, 3.5.2.1.2

metadata fields

batch loading custom, 3.9.1.7, 3.9.1.7

Metadata Implementor, A.1.4.4 migration bundle subdirectories, 7.3.1.1 migration directory, 7.3.1.1 migration interface screens, A.4.1 Migration Main screen, A.4.1.1 migration main screen, A.4.1.1 migration process, 7.3.2 migration status, 7.3.3.9 migration structure, 7.3.1.1 migration template

creation, 7.3.3.1

migration tips, 7.3.2 minor revision label, A.1.2.2.1, A.1.2.2.2 minor revision label sequence, 3.1.2.1 MinorRevSeq, A.1.2.2.1, A.1.2.2.2 moved folders, 7.11.4 moving

default archive collection, 7.4.3.4

MultiUpload, A.1.2.2.1, A.1.2.2.2

N

named password

uses for, 4.7.1

named password connections, 4.7.3.1, 4.7.3.2 Need to Know

features, B.1.1

overview, B.1

Netscape SDK, A.1.6.8 network access, 4.1.3 new component

creating, 5.3.1

normalization

discarding WHERE clause conditions, 3.4.6.2.3

finding range queries, 3.4.6.2.3

qualify WHERE clause conditions, 3.4.6.2.3

reformatting WHERE clause conditions, 3.4.6.2.3

stage 3 of optimization process, 3.4.6.2.3

NTK. See Need to Know NumConnections, A.1.6.8

O

one-time configuration export, 7.3.3.4

opening

archive collection, 7.4.3.1

component, 5.3.3.5

Operators

column description, 3.4.6.8.4

Optimized Fields

assigning, 6.1.4.2

editing, 6.1.4.2

optimizing queries

by reformatting, 3.4.6.3

example - adding multiple hints, 3.4.6.3.2

example - adding single hint, 3.4.6.3.1

Option List screen, A.2.4.9 option lists

editing, 4.5.3.2.2

optional parameters, Batch Loader, 3.9.1.6 options

System Properties

content server, 3.1.6

database, 3.1.5

general, 3.1.2

Internet, 3.1.4

Oracle, A.1.2.5

Archiver issues, 7.13.6

Oracle Enterprise Manager Fusion Middleware Control Console, 1.3.1 Oracle Fusion Middleware

using single sign-on, 4.2.3

using SSL, 4.2.2

using web services, 4.2.5

Oracle Fusion Middleware application

using LDAP authentication provider, 4.2.1

Oracle Portlets, 3.7.1.2.5 Oracle Query Optimizer

overview, 3.4.6.1

Oracle Text Search

introduction, 6.1

Oracle Text Search component

requirements for, 6.1.1

search results menu options, 6.1.6

Oracle WebLogic Scripting Tool (WLST), 1.3.3 Oracle WebLogic Server Administration Console, 1.3.2 Order

column description, 3.4.6.8.6

order by

supported sort construct, 3.4.6.6

outer join

supported sort construct, 3.4.6.6

Outgoing Http Provider Page, A.1.6.14 Outgoing provider, 3.7.1.1 outgoing provider

adding, 3.7.1.2.1, 3.7.2.1

Outgoing Provider page, A.1.6.4, A.1.6.4 Output page, A.1.1.3 output, viewing content server, 3.2.2 overview, 7.11 owner, transfer, 7.7.1.3

P

package uploading, 7.2.1

packaging, A.3.4.2, A.3.4.3

parameters

adding, A.3.3.12, A.3.3.13

editing, A.3.3.12, A.3.3.13

parameters, optional Batch Loader, 3.9.1.6 parsing

stage 2 of optimization process, 3.4.6.2.2

Partition Listing page, A.1.4.1

Action, A.1.3.11, A.1.4.1

Add Partition, A.1.3.11, A.1.4.1

Is Active, A.1.3.11, A.1.4.1

Partition Name, A.1.4.1

Partition Root, A.1.3.11, A.1.4.1

Partition Name, A.1.4.1, A.1.4.2 Partition Root, A.1.4.1, A.1.4.2 Partitioning, 3.5.4.5.1 PartitionList table

CapacityCheckInterval, 3.5.3.1

DuplicationMethods, 3.5.3.1

IsActive, 3.5.3.1

PartitionName, 3.5.3.1

PartitionRoot, 3.5.3.1

SlackBytes, 3.5.3.1

PartitionName, 3.5.3.1 PartitionRoot, 3.5.3.1 passthru, 3.4.5.1 password

JDBC, A.1.2.5

passwords

defining, 4.7.3.2

hashing, 4.7.3.1

protection, 4.7.3

path construction, 3.5.4.5 path options, System Properties, 3.1.8 PathConstruction table

AutoCreateLimit, 3.5.3.4

FileStore, 3.5.3.4

PathExpression, 3.5.3.4

StorageRule, 3.5.3.4

PathExpression, 3.5.3.4 PathMetaData table, 3.5.4.1

ArgumentFields, 3.5.3.3

Arguments, 3.5.3.3

FieldName, 3.5.3.3

GenerationAlgorithm, 3.5.3.3

RequiredForStorage, 3.5.3.3

performance, 4.4.1.3

search, 4.3.1.2.1

User Admin, 4.3.1.2.2

permissions, 4.1.1.2, 4.3.3.3, 4.4.3.4

Admin, 4.3.3.3, A.2.2.5

Delete, 4.3.3.3, A.2.2.5

Read, 4.3.3.3, A.2.2.5

Write, 4.3.3.3, A.2.2.5

Permissions By Role screen, A.2.2.3 Permissions by Role screen, A.2.2.3 persistence

characteristic of hint cache, 3.4.6.10.5

physical access, 4.1.3 portlets, 3.7.1.2.5 predefined accounts, 4.4.1

limiting display to, A.1.2.3.1, A.1.2.3.2

Predefined Accounts screen, A.2.3.1 predefined accounts, creating, 4.4.2.2 predefined dynamic tables, A.3.3.8.1 predefined resources, A.3.3.15 predefined roles, 4.3.3.1 predefined security groups, 4.3.1 predefined service actions, A.3.3.4.1 predefined static tables, A.3.3.9.1, A.3.3.9.1 predefined template tables, A.3.3.10.1 prefix, account, 4.4.1.2 preparing

batch load file, 3.9.2, 3.9.2.1

preserving case, A.1.2.5 Preview provider, 3.7.1.1 Preview Provider page, A.1.6.7, A.1.6.7 preview provider, adding, 3.7.1.2.4, 3.7.2.4 Preview Screen, A.4.1.7 Priority, A.1.6.8 privilege levels, 4.7.2.3.2 privileges

assigning to accounts, 4.7.2.3.2

procedure

Editing a Storage Rule, 3.5.2.2.4

process

archiving, 7.5.2.1

migration, 7.3.2

provider

LDAP, A.1.6.8

Provider Class, A.1.4.4, A.1.6.8 Provider Description, A.1.4.4 Provider Information page, A.1.6.2, A.1.6.2 Provider Name, A.1.4.4 provider pages

Database Provider, A.1.6.5

Incoming Provider, A.1.6.6

LDAP, A.1.6.13

Outgoing Provider, A.1.6.4

Preview Provider, A.1.6.7

Provider Information, A.1.6.2

Providers, A.1.6.1

ProviderClass, A.1.6.8 ProviderConfig, A.1.6.8 ProviderConnection, A.1.6.8 providers, 3.7.1

adding, 3.7.1.2

adding database, 3.7.1.2.2, 3.7.2.2

adding incoming, 3.7.1.2.3, 3.7.2.3

adding LDAP, 3.7.1.2.5

adding outgoing, 3.7.1.2.1, 3.7.2.1

adding preview, 3.7.1.2.4, 3.7.2.4

Database, 3.7.1.1

DefaultFileStore, 3.7.1.1

defining sockets, 7.7.4.3

deleting, 3.7.2.9

editing information, 3.7.2.8

HTTP, 3.7.1.1

Incoming, 3.7.1.1

Jps User, 3.7.1.1

LDAP, 3.7.1.1

outgoing, 3.7.1.1

Preview, 3.7.1.1

system, 3.7.1.1, 3.7.1.1, 3.7.1.1

SystemDatabase, 3.7.1.1, 3.7.1.1

SystemServerSocket, 3.7.1.1, 3.7.1.1

Providers page, A.1.6.1, A.1.6.1 proxied, 7.7.1.3 proxied archive, 7.7.1.3 proxied collection, 7.7.1.3 Proxied Connections page, A.2.5.2 proxied target transfer, 7.7.1.3 proxy connections

data, 4.7.3.2

options, 4.7.3.2

overview, 4.7.1

typical uses, 4.7.1

Public security group, 4.3.1

Q

queries

creating export, 7.5.2.2

query

checking hint cache for hints, 3.4.6.13.2

converting, 3.4.6.12.1

modifying, 3.4.6.12.3

modifying entry to hint cache, 3.4.6.13.4

removing entry to hint cache, 3.4.6.13.6

query analysis

stage 1 of optimization process, 3.4.6.2.1

Query Converter page, A.1.3.9

accessing, 3.4.6.12

converting data source or query

data source, 3.4.6.12.1

modifying data source or query

data source, 3.4.6.12.3

query hints

overview, 3.4.6.4

syntax, 3.4.6.5

query optimization process

reformatting queries to optimize searches, 3.4.6.3

stage 1 - query analysis, 3.4.6.2.1

stage 2 - parsing, 3.4.6.2.2

stage 3 - normalization, 3.4.6.2.3

stage 4 - select hint, 3.4.6.2.4

stage 5 - reformat query, 3.4.6.2.5

R

range queries

finding, 3.4.6.2.3

Read access, 4.1.3 Read permission, 4.3.3.3, A.2.2.5 Readme file, 5.3.1.2 rebuild

configuring, 3.4.2.4

rebuilding

search collection, 3.4.2.3

recommendations, security, 4.1.3 records, file, 3.9.1.1 redirect, adding in Batch Loader, 3.9.3.7 reference input value, 4.7.2.3.1 reformat query

stage 5 of optimization process, 3.4.6.2.5

reformatting queries

adding multiple hints, 3.4.6.3.2

adding single hint, 3.4.6.3.1

to optimize searches, 3.4.6.3

Registered Exporter screen, A.4.5.2 relative web root, A.1.2.4.1, A.1.2.4.2 removing

archive collections, 7.4.3.3

archive files from batch file, 7.4.4.1

component, 5.3.3.4

Renditions, A.1.4.5 RenditionsOnFileSystem, 3.5.3.2 replicating

export, 7.8.2.1

import on import machine, 7.8.2.2

replication, 7.8, 7.8.1 replication issues (Archiver), 7.13.5 Repository Manager

application, 1.4.1.3

Indexer tab, A.1.3.1, A.1.3.1

RequiredForStorage, 3.5.3.3 requirements

Batch Loader delete action, 3.9.1.4.1

Batch Loader insert action, 3.9.1.3.1

Batch Loader update action, 3.9.1.5.1

Reset, A.1.4.2 Resource Selection Dialog screens, A.3.3.15 resource tables, 3.5.3

FileCache table, 3.5.3.7

FileStorage table, 3.5.3.6

FileSystemFileStoreAlgorithmFilters table, 3.5.3.5

PartitionList table, 3.5.3.1

PathConstruction table, 3.5.3.4

PathMetaData table, 3.5.3.3

StorageRules table, 3.5.3.2

resources

component, A.3.3.14

custom, 5.3.1.1

predefined, A.3.3.15

restarting content server with Oracle WebLogic Scripting Tool, 3.3.3.2 restarting content server with Oracle WebLogic Server Administration Console, 3.3.3.1 resultset, 4.8.3.1 reusing hint cache entries

characteristic of hint cache, 3.4.6.10.1

revision labels

defining, A.1.2.2.1, A.1.2.2.2

revision sequence ranges, 3.1.2.2 revisions

label sequence, 3.1.2.1

role prefix, A.1.6.8

depth parameter, A.1.6.8

RolePrefix, A.1.6.8 roles, 4.1.1.2, 4.3.3, 4.4.3.4, 4.4.3.5

admin, 4.3.3.1

assigning to users, 4.3.4.3

contributor, 4.3.3.1

deleting, 4.3.4.2

guest, 4.3.3.1

predefined, 4.3.3.1

sysmanager, 4.3.3.1

rules

transfer, 7.7.3

running

applications as applets, 1.5.1

applications in stand-alone mode, 1.5.2

Batch Loader, 3.9.3, 3.9.3.1

content server on Windows, 1.5

S

samples

batch load files, 3.9.2

Schema Publishing status and actions, A.1.3.11 search collection instance, 6.1.1

platform, 6.1.1

search collections

configuring rebuild, 3.4.2.4

rebuilding, 3.4.2.3

search index, 3.4.2.1

configuring update, 3.4.2.4

Content Server Analyzer analysis, 3.10.7.5

updating, 3.4.2.2

search results

displaying categories, 6.1.6

Search Results page

Oracle Text Search fields, 6.1.4.4

with Oracle Text Search, 6.1.6

search results presentation

settings, B.5.3, B.5.3, B.5.3

searching

performance, 4.3.1.2.1

searching with Oracle Text Search component, 6.1.5 SearchResults template, A.3.3.19 SearchResultTemplates table, A.3.3.10.1 Secure security group, 4.3.1 Secure Sockets Layer (SS), A.1.6.8 Secure Sockets Layer (SSL), 4.1.1.3, 4.7.4, A.1.2.4.1 secure sockets layer (SSL), A.1.2.4.1, A.1.2.4.2 secured connections

overview, 4.7.3

security

automatically authenticating Oracle BPM Worklist users in Windows Native authentication environments, 4.2.3.3

available documentation, 4.2.6

combining integration methods, 4.1.1.3

configuring, 3.1.3

configuring for two-way SSL communication, 4.2.2.1

configuring Oracle SOA Suite and Oracle HTTP Server for SSL communication, 4.2.2.3

configuring SSL between SOA composite application instances and Oracle WebCache, 4.2.2.5

database access, 4.1.3

internal, 4.1.1.2

listing Oracle Internet Directory as the first authentication provider, 4.2.4

network access, 4.1.3

options, 4.1.1.2

performance, 4.4.1.3

permissions, 4.4.3.4

physical access, 4.1.3

Read access, 4.1.3

recommendations, 4.1.3

roles, 4.4.3.4, 4.4.3.5

security groups, 4.5.1

setting up users

subadministrator, 4.5.3

switching from non-SSL to SSL configurations with Oracle BPM Worklist, 4.2.2.4 users, 4.4.3.5 Write access, 4.1.3 security groups, 4.1

adding, 4.3.2.1

deleting, 4.3.2.2

JSP enabled, A.1.2.2.1, A.1.2.2.2, A.1.2.6

predefined, 4.3.1

Public, 4.3.1

Secure, 4.3.1

tips, 4.3.1.2.1

working with, 4.5.1

Security Providers component, 4.1.1.3 select hint

hint cache, 3.4.6.10

hint rules table, 3.4.6.7

stage 4 of optimization process, 3.4.6.2.4

Select Users screen, A.2.4.12 sequence, revision label, 3.1.2.1 server output

viewing, 3.2.2

Server Status page, A.1.1.2 server-wide tracing, 3.10.4.1 service resources, A.3.3.4, A.3.3.7

action, A.3.3.4

adding, A.3.3.16

editing, A.3.3.16

subjects, A.3.3.16.1

ServiceHandlers table, A.3.3.9.1 setting

export options, 7.5.2.7

import options, 7.6.3.4

transfer destination (target archive), 7.7.4.4

setting up

subadministrator, 4.5.3

setup

automatic export, 7.8.2.1

Shared Directory Path, A.1.2.7 shortcuts of folders and content items, 7.11.4 Show Columns screen, A.2.1.3 Show only known accounts, A.1.2.3.1, A.1.2.3.2 Show Path Metadata, A.1.4.5 ShowOnlyKnownAccounts, A.1.2.3.1, A.1.2.3.2 single revision replications, 7.8.1.1 single sign-on, 4.2.3 Slack Bytes, A.1.4.2 SlackBytes, 3.5.3.1 slashes, in accounts, 4.4.1.2 SMTP Port, A.1.2.4.1, A.1.2.4.2 SmtpPort, A.1.2.4.1, A.1.2.4.2 SOA composite applications

configuring for two-way SSL communication, 4.2.2.1

configuring Oracle SOA Suite and Oracle HTTP Server for SSL communication, 4.2.2.3

SocketHostAddressSecurityFilter, A.1.2.6 sockets, defining as providers, 7.7.4.3 sort constructs

group by, 3.4.6.6

inner join, 3.4.6.6

order by, 3.4.6.6

outer join, 3.4.6.6

supported, 3.4.6.6

source archive, 7.7.1.3 Source Path, A.1.6.8 source transfer, proxied

proxied source transfer, 7.7.1.3

source, transfer, 7.7.1.3 SourcePath, A.1.6.8 special characters, 4.7.2.3.4 specifying

Content Server Analyzer log directory, 3.10.7.2

file to retrieve, 7.6.3.5

SSL, 4.2.2

configuring SOA composite applications for two-way SSL communication, 4.2.2.1

SSL (Secure Sockets Layer), A.1.2.4.1, A.1.2.4.2, A.1.6.8 SSO, 4.2.3 standalone mode

configuring external database provider, 1.5.2.2

configuring JDBC database drivers, 1.5.2.3

configuring system database provider, 1.5.2.1

running application on UNIX, 1.5.2.5

running application on Windows systems, 1.5.2.4

stand-alone mode, running applications, 1.5.2 starting

content server, 1.5

Content Server Analyzer analysis, 3.10.7.3

content server on Windows, 1.5

starting content server with Oracle Enterprise Manager Fusion Middleware Console, 3.3.1.3 starting content server with Oracle WebLogic Scripting Tool, 3.3.1.2 starting content server with Oracle WebLogic Server Administration Console, 3.3.1.1 state

Indexer, A.1.3.1

static resource tables, A.3.3.9, A.3.3.20 static tables

creating, 5.3.2.8

status

Indexer, A.1.3.1

status information, 3.10 status report

Content Server Analyzer, 3.10.7.8

stopping content server with Oracle Enterprise Manager Fusion Middleware Console, 3.3.2.3 stopping content server with Oracle WebLogic Scripting Tool, 3.3.2.2 stopping content server with Oracle WebLogic Server Administration Console, 3.3.2.1 Storage Rule page, A.1.4.5 Storage Rule table

IsWeblessStore, 3.5.3.2

RenditionsOnFileSystem, 3.5.3.2

StorageRule, 3.5.3.2

StorageType, 3.5.3.2

Storage Rules, A.1.4.4 storage types

FileStorage, 3.5.3.2

JdbcStorage, 3.5.3.2

StorageRule, 3.5.3.2, 3.5.3.4 StorageType, 3.5.3.2 string resources

adding, A.3.3.11

editing, A.3.3.11

subadministrators

setting up, 4.5.3

subjects, A.3.3.16.1 SubscriptionTypes table, A.3.3.9.1 substitution, 4.7.2.3.3 synchronization, 7.11.1, 7.11.4 SysAdminAddress, A.1.2.4.1, A.1.2.4.2 sysmanager role, 4.3.3.1 system administrator

e-mail address, A.1.2.4.1, A.1.2.4.2

system audit information, 3.10.3 System Audit Information page, A.1.10.5 system database

configuring for standalone mode, 1.5.2.1

System Locale, A.1.2.6 System MBean Browser

KeystoreLocation property, 4.2.2.1

System Properties

configuration files, 3.1.1

content security, 3.1.3

content server, 3.1.6

database, 3.1.5

date format, 3.1.7.1

general options, 3.1.2

Internet options, 3.1.4

paths, 3.1.8

utility, 1.4.1.1

system properties

about, 3.1.1

System Properties application, 3.1.1 System Properties page

about, A.1.2.1

Content Security tab, A.1.2.3.1

Database tab, A.1.2.5

Internet tab, A.1.2.4.1

Options tab, A.1.2.2.1

Paths tab, A.1.2.7

Server tab, A.1.2.6

System Timezone, A.1.2.6 SystemDatabase provider, 3.7.1.1 SystemLocale, A.1.2.6 SystemServerSocket provider, 3.7.1.1 SystemTimeZone, A.1.2.6

T

Table

column description, 3.4.6.8.2

tables

FileCache table, 3.5.3.7

FileStorage table, 3.5.3.6

FileSystemFileStoreAlgorithmFilters table, 3.5.3.5

PartitionList table, 3.5.3.1

PathConstruction table, 3.5.3.4

PathMetaData table, 3.5.3.3

StorageRules table, 3.5.3.2

target archive, 7.7.1.3 target transfer, proxied, 7.7.1.3 target, setting transfer, 7.7.4.4 target, transfer, 7.7.1.3 targetable archive, 7.7.1.3 targetable, making an archive, 7.7.4.2 tasks

archiving, 7.5.2.1

Indexer, 3.4.2.1

template resources, A.3.3.10

adding, A.3.3.19, A.3.3.21

editing, A.3.3.19, A.3.3.21

template tables, A.3.3.10.1 Test NTK Content Security page, B.5.5 testing

configuration scripts, B.4.1.1

security script, B.5.5

timezone, system, A.1.2.6 tips

security groups, 4.3.1.2.1

tracing, 3.10.4

applet-specific, 3.10.4.2

server-wide, 3.10.4.1

transfer issues (Archiver), 7.13.3 Transfer Options screen, A.4.6.2 transfer owner, 7.7.1.3 transfer source, 7.7.1.3 transfer target, 7.7.1.3 Transfer To tab, A.4.6.1 transfer, local, 7.7.1.3 transferring, 7.7.1.3

batch files to different archive, 7.7.4.5

content, 7.7.1

transfers

local, 7.7.2.1

rules, 7.7.3

setting destination, 7.7.4.4

troubleshooting

configuration information, 3.10.2

configuration variables, 3.10.8

Content Server analyzer, 3.10.6, A.1.9.1

environment packager, 3.10.5

system audit information, 3.10.3

tracing, 3.10.4

tutorial

creating component, 5.3.2

types

users, 4.1.2

types of users

administrator, 1.1

consumers, 1.1

contributors, 1.1

U

understanding

Archiver

batch files, 7.7.3

components, 7.4.1.1

logs, 7.4.1.5

security options, 4.1.1.2 UNIX

Batch Loader example, 3.9.3.3.2

BatchBuilder example, 3.9.2.5.2

running administration application on, 1.5.2.5

services, 1.5.2.5

unpackaging a component, 5.3.3.7 Update, A.1.4.2 update

configuring search index, 3.4.2.4

update action, 3.9.1.5

example, 3.9.1.5.2, 3.9.1.5.3

requirements, 3.9.1.5.1

updating

search index, 3.4.2.2

updating folder structure archives, 7.11.3.2 upload applet

chunking, 3.1.2.5

Upload Bundle Screen, A.4.1.2 uploading a component, 5.2.3 uploading bundles, 7.3.3.6 usage, 7.11.1 Use Java Database Connectivity, A.1.2.5 Use Secure Sockets Layer, A.1.2.4.1, A.1.2.4.2 UseAccounts, 4.4.2.1 UseFullGroupName, A.1.6.8 UseGroupFilter, A.1.6.8 UseNetscape, A.1.6.8 User Admin

Aliases tab, A.2.4.10

application, 1.4.1.3

editing user information fields, 4.5.3.2.3

performance, 4.3.1.2.2

Users tab, A.2.4.1

user attributes, A.1.6.8 user credentials

order evaluated, 4.7.2.1

user information fields, 4.5.3.1

adding, 4.5.3.2.1

editing, 4.5.3.2.3

E-mail Address, 4.5.3.1

Full Name, 4.5.3.1

User Locale, 4.5.3.1

User Type, 4.5.3.1

using, 4.5.3

User Locale user field, 4.5.3.1 user name, JDBC, A.1.2.5 User Type user field, 4.5.3.1 user types, 1.1 UserMetaDefinition table, A.3.3.9.1 users, 4.4.3.5, 4.4.3.6

adding, 4.5.2.1

assigning accounts, 4.4.2.5

assigning roles, 4.3.4.3

deleting, 4.5.2.3

editing, 4.5.2.2

external, 4.1.2.1

local, 4.1.2.2

setting up

subadministrator, 4.5.3

types, 4.1.2 UseSecureLdap, A.1.6.8 UseSSL, A.1.2.4.1 using

accounts, 4.5.1

Archiver logs, 7.4.1.5

Component Manager, 5.2

Component Wizard, 5, 5.3

System Properties, 3.1.1

user information fields, 4.5.3

using folder structure archives, 7.11.3.3

V

Values

column description, 3.4.6.8.7

values

Archiver mapping, 7.6.3.3

Batch Loader mapping file, 3.9.2.2.2

credential input, 4.7.2.2

privilege levels, 4.7.2.3.2, 4.7.2.3.2

referencing input value, 4.7.2.3.1

special characters, 4.7.2.3.4

substitution, 4.7.2.3.3

variables, see configuration variables, 7.11.3.4 Vault Path, A.1.4.5 verbose logging, 3.10.1 View Batch Files screen, 7.4.4.1 View Exported Content Items screen, A.4.2.10 virtual folder administration configuration, 7.10.1

W

web server

name, A.1.2.4.1, A.1.2.4.2

relative web root, A.1.2.4.1, A.1.2.4.2

security, 4.1.3

web services, 4.2.5 Web URL File Path, A.1.4.5 webBrowserPath, A.1.2.7 WebDAV, 3.7.1.2.3 WebDAV issues (Archiver), 7.13.4 weblayout

accounts, 4.4.1.2

Weblayout Editor

application, 1.4.1.3

Weblayout Publishing status and actions, A.1.3.11 WebUrlMapPlugin

constructing a map entry, 3.6.1

examples of mapping, 3.6.4

variables, 3.6.2

WebUrlMaps screen, A.1.5.2 Web-viewable Path, A.1.4.5 WHERE clause conditions

discarding, 3.4.6.2.3

qualifying, 3.4.6.2.3

reformatting, 3.4.6.2.3

Win32

Batch Loader example, 3.9.3.3.1

BatchBuilder example, 3.9.2.5.1

Windows

running administraiton application on, 1.5.2.4

running content server, 1.5

WLST, 1.3.3 Workflow Admin

application, 1.4.1.3

working with

batches of files, 3.9

components, 5.2

exporting user interface, 7.5.1

security groups, 4.5.1

working with Java code, 5.3.1.1 working with resources, 5.3.1.1 Write access, 4.1.3 Write permission, 4.3.3.3, A.2.2.5

X

xPartitionId, 3.5.2.1.2

xStorageRule, 3.5.2.1.2

xWebFlag, 3.5.2.1.2

Z

Zip file, 5.3.3.1

Zone Fields Configuration page, A.1.3.6

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2014, Oracle and/or its affiliates. All rights reserved.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.