1 Introduction

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:

• Section 1.1, "Document Organization"

• Section 1.2, "What's New and Changed"

1.1 Document Organization

The information contained in this guide is based on Oracle Content Server 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 Content Server functionality, which include:

  • Section 5.7, "Content Items"

  • Section 5.8, "Oracle Content Server"

  • Section 5.9, "Database"

  • Section 5.10, "Indexing"

  • Section 5.11, "Schema"

  • Section 5.12, "Searching"

  • Section 5.13, "Security"

  • Section 5.14, "Web Server"

  • Section 5.15, "Workflow"

• Chapter 6, "Core Oracle Content Server Variables and Functions," describes each function and variable used in core Oracle 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 Oracle Content Server system, including:

  • Section 7.8, "Archiver"

  • Section 7.9, "Batch Loader"

  • Section 7.10, "Clients"

  • Section 7.11, "Content Profiles"

  • Section 7.12, "Date and Time"

  • Section 7.13, "Debugging"

  • Section 7.14, "Directories and Paths"

  • Section 7.15, "Dynamichtml"

  • Section 7.16, "Field Display"

  • Section 7.17, "Idoc Script"

  • Section 7.18, "JSP"

  • Section 7.19, "Localization"

  • Section 7.20, "Page Display"

  • Section 7.21, "Personalization"

  • Section 7.22, "ResultSets"

  • Section 7.23, "Strings"

  • Section 7.24, "Templates"

  • Section 7.25, "Users"

• Chapter 8, "Management and Configuration Variables and Functions," describes each function and variable used to configure and manage the Oracle 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 Oracle Content Server system, including:

  • Section 9.3, "Conversion"

  • Section 9.4, "Folders and WebDAV"

  • Section 9.5, "HTML Preview"

  • Section 9.6, "Pop-Up Calendar"

  • Section 9.7, "Records Manager"

• Chapter 10, "Feature and Product Variables and Functions," describes each function and variable related to additional features and products for the Oracle Content Server system, with details on usage.

An index is provided.

1.2 What's New and Changed

The following information has been added or changed for this release:

• The following variables or functions have been added:

  • "ddAppendIndexedColumnResultSet"

  • "ddAppendResultSet"

  • "ddApplyTableSortToResultSet"

  • "ddGetFieldList"

  • "ddIncludePreserveValues"

  • "ddLoadIndexedColumnResultSet"

  • "ddLoadResultSet"

  • "ddMergeIndexedColumnResultSet"

  • "ddMergeResultSet"

  • "ddMergeUsingIndexedKey"

  • "ddSetLocal"

  • "ddSetLocalByColumnsFromFirstRow"

  • "ddSetLocalByColumnsFromFirstRowIndexed"

  • "ddSetLocalEmpty"

  • "ddSetLocalEmptyByColumns"

  • "idocTestForInclude"

  • "CollectionInfoEnabled"

  • "CollectionLinkEnabled"

  • "RecordsManagementDenyAuthorFreePassOnRMSecurity"

  • "RecordsManagementNumberOverwriteOnDelete"

  • "RmaAddDocWhereClauseForScreening"

  • "RmaAllowKeepOrDestroyMetadataOption"

  • "RmaEnableFilePlan"

  • "RmaEnableFixedClones"

  • "RmaEnablePostFilterOnScreening"

  • "RmaFilePlanVolumePrefix and RmaFilePlanVolumeSuffix"

  • "RmaFixedClonesTitleSuffix"

  • "RMAHideExternalFieldsFromCheckInUpdate"

  • "RMAHideExternalFieldsFromSearchInfo"

  • "RmaNotifyDispReviewerAndCatAuthor"

  • "RmaNotifyReviewerAndAlternateReviewer"

  • "rs"

  • "rsAddFieldsWithDefaults"

  • "rsCreateReference"

  • "rsLoopInclude"

  • "rsLoopSingleRowInclude"

  • "SctAutoTruncateDataStrings"

  • "SctComponentDir"

  • "SctDebugLogEnabled"

  • "SctDebugLogFilePath"

  • "SctDebugServiceBinderDumpEnabled"

  • "SctDoNotArchive"

  • "SctDoNotPopulateAccessLogColumns"

  • "SctExternalUserLogEnabled"

  • "SctFilterPluginLogDir"

  • "SctIgnoreDirectories"

  • "SctIgnoreFileTypes"

  • "SctLogDir"

  • "SctLogEnabled"

  • "SctLogSecurity"

  • "SctMaxRecentCount"

  • "SctMaxRereadTime"

  • "SctReductionAvailableDatesLookback"

  • "SctReductionLogDir"

  • "SctReductionRequireEventLogs"

  • "SctrEnableSecurityCheck"

  • "SctScheduledReductionEnable"

  • "SctSimplifyUserAgents"

  • "SctSnapshotEnable"

  • "SctSnapshotLastAccessEnable"

  • "SctSnapshotLastAccessField"

  • "SctSnapshotLongCountEnable"

  • "SctSnapshotLongCountField"

  • "SctSnapshotLongCountInterval"

  • "SctSnapshotShortCountEnable"

  • "SctSnapshotShortCountField"

  • "SctSnapshotShortCountInterval"

  • "SctTrackContentAccessOnly"

  • "SctUseGMT"

  • "WebDAVMaxInactiveInterval"

• The following variables or functions have been modified:

  • "ServiceStartupTimeout"

  • "IdcHomeDir"

  • "CollectionReleasedOnly"

  • "IdcNativeDir"

  • "IdcResourcesDir"

  • "ShowContentForStorageBrowse"

• The following variables or functions have been removed:

  • AcadUseLISPInterface

  • AccountMapPrefix

  • AcctPermDelim

  • AcctPrefix

  • AdjustPrinterMargins

  • AdsSimpleAuth

  • AdsUserPassword

  • AllowIntranetUsers

  • AllowPassThru

  • AttributeMap

  • AutoCad2000PlotterFilePath

  • CGI_DEBUG

  • CGI_RECEIVE_DUMP

  • CGI_SEND_DUMP

  • CgiFileName

  • CLASSPATH

  • ClusterBinDirRule

  • ClusterNodeAddress,

  • ClusterNodeName

  • ComputerName

  • ConnectionName

  • CreatePDFThumbnails

  • CustomConversionWaitTime

  • CustomConverterPath

  • DebugMode

  • DebugStdConversion

  • DefaultAuth

  • DefaultMasterDomain

  • DefaultNetworkAccounts

  • DisableAmberLayouts

  • DisableClassicLayoutPublishing

  • DisableCollegiateSkinPublishing

  • DisableStellent05SkinPublishing

  • DisableStellentSkinPublishing

  • DisableWindowsPublishing

  • DisplayPSOrigin

  • DistillerNormJobSetting

  • DistillerOptJobSetting

  • DocConverterEngineDir

  • EnableCopyConvertCopy

  • ExcludeConversionFilter

  • ExclusiveIncludeConversionFilter

  • FILTER_DEBUG

  • IdcAdminServerPort

  • ImageAlchemyExePath

  • IncludeXmlFlexionDocType

  • IndexerPath

  • IndexVaultFile

  • IsJdbc

  • IsThumbnailPresent

  • LocalGroupServer

  • LogWithConnectionName

  • MaxNumberConvertedHistoryShow

  • MaxNumRecursiveStepDefinitions

  • NetworkAdminGroup

  • OptimizePDF

  • PdfVersion

  • PLUGIN_DEBUG

  • ProfileCacheTimeoutInMins

  • RolePrefix

  • SetPdfVersion

  • ThumbnailDPI

  • ThumbnailJPEGQuality

  • ThumbnailSizeLimit

  • ThumbnailSizingMethod

  • ThumbnailTemplate

  • UseAdobeDistiller

  • UseAlchemy111

  • UseAutoCad2000

  • UseAutocadModelSpace

  • UseFullGroupName

  • UseGroupFilter

  • UseLightweightToPostscriptStep

  • UseLocalGroups

  • UseSearchML

  • UseShortNamesAlways

  • UseXmlEmbeddings

  • UseXmlExtensibleDTD

  • UseXmlNoDTD

  • UseXmlNoReference

  • UseXmlPStyleNames

  • UseXmlSchema

  • UseXmlSchemaDTD

  • XmlTimeout

• Collaboration Manager is not supported. Core workflow variables are still supported.

• References to install_dir have been changed in support of Oracle Content Server deployment and configuration on Oracle WebLogic Server to one of the following:

  • UCM_ORACLE_HOME: Refers to the ORACLE_HOME and Oracle WebLogic Server install directories for an Oracle UCM domain. Default directories are provided, however, sites can specify alternative directories.

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

  • DomainHome: Refers 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: Refers to the type of Oracle UCM server deployed on an Oracle WebLogic Server, domain, used as the context root (default HttpRelativeWebRoot configuration value). Possible values include:

    • cs (Content Server)

    • ibr (Inbound Refinery)

    • urm (Universal Records Management)

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