Idoc Script is a proprietary server-side scripting language. This guide describes Idoc Script usage and syntax, and provides detailed descriptions and examples of predefined Idoc Script functions, variables, and configuration settings.
This chapter contains these topics:
The information contained in this guide is based on Oracle WebCenter Content 11g Release 1 (11.1.1). The information is subject to change as the product technology evolves and as hardware and operating systems are created and modified. Due to the technical nature of browsers, databases, web servers, and operating systems, Oracle cannot warrant compatibility with all versions and features of third-party products.
This guide is divided into the following chapters:
Chapter 2, "Idoc Script Application," describes Idoc Script and how it is used.
Chapter 3, "Master List: Idoc Script by Type," lists all variables and functions sorted by type (configuration variable, settable variable, and so on).
Chapter 4, "Master List: Idoc Script by Usage," lists all variables and functions sorted by where they are used (for example, in Workflows, or in the Debugger).
Chapter 5, "Core Functions by Type and Usage," provides a subset of information in Chapter 3, "Master List: Idoc Script by Type," and Chapter 4, "Master List: Idoc Script by Usage," listing only those variables and functions that relate to core Oracle WebCenter Content Server (Content Server) functionality, which include:
Chapter 6, "Core Oracle WebCenter Content Server Variables and Functions," describes each function and variable used in core Content Server processing, with details on usage.
Chapter 7, "Management and Configuration Options by Type and Usage," lists only those variables and functions used to manage the Content Server system, including:
Chapter 8, "Management and Configuration Variables and Functions," describes each function and variable used to configure and manage the Content Server system, with details on usage.
Chapter 9, "Feature and Product Variables and Functions by Type and Usage," lists variables and functions related to additional features and products for the Content Server system, including:
Chapter 10, "Feature and Product Variables and Functions," describes each function and variable related to additional features and products for the Content Server system, with details on usage.
An index is provided.
The following information has been added or changed for this release:
The following variables or functions have been added:
The following variables or functions have been modified:
The following variables or functions have been removed:
References to "Record Manager and Retention Manager" have been changed to "Oracle WebCenter Content: Records (Records)."
Collaboration Manager is not supported. Core workflow variables are still supported.
Added Folders variables.
Added note to Section 2.3.2, "Variables" that not all configuration variable values set by code are listed in the IntradocDir/config/config.cfg file by default.
WebCenter Content documentation uses the following terms when referring to variables in the directories associated with the WebCenter Content installation, configuration, and deployment:
IdcHomeDir: This variable refers to the
ucm/idc directory in the Oracle WebCenter Content home where the WebCenter Content server media is located. The server media can run Oracle WebCenter Content Server, Oracle WebCenter Content: Inbound Refinery, or Oracle WebCenter Content: Records software. This is essentially a read-only directory. The default location is
/ucm/idc. The variable portion of the default location can be changed, but the path cannot be changed from
DomainHome: This variable refers to the user-specified directory where a WebCenter Content application is deployed to run on an Oracle WebLogic Server application server. The
/bin directory contains the intradoc.cfg file and executables. The default location for
base_domain, but you can change the path and domain name (
base_domain) during the deployment of a WebCenter Content application to an application server.
short-product-id: This variable refers to the type of WebCenter Content server deployed to an application server. This name is used as the context root (default
HttpRelativeWebRoot configuration value). Possible values include:
cs (Oracle WebCenter Content Server)
ibr (Oracle WebCenter Content: Inbound Refinery)
urm (Oracle WebCenter Content: Records)
IntradocDir: This variable refers to the root directory for configuration and data files specific to a Content Server instance that is part of a WebCenter Content application deployed to an application server. This Idoc Script variable is configured for one type of Content Server instance: Content Server (
cs), Inbound Refinery (
ibr), or Records (
urm). This directory can be located elsewhere, but the default location is
short-product-id. The specified directory must be an absolute path to the instance directory and must be unique to a particular server or node. The directory files include startup files (intradoc.cfg and executables).