Oracle Fusion MiddlewareIdoc Script Reference Guide

11g Release 1 (11.1.1)

E10726-01

May 2010

Oracle Fusion Middleware Idoc Script Reference Guide, 11g Release 1 (11.1.1)

E10726-01

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

Primary Author: Karen Johnson

Contributing Author: Will Harris, Jean Wilson

Contributor: Sebastian Celis, Eva Cordes, Alec Kloss, Rick Petty, Sam White

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.

iii

Contents

Preface ............................................................................................................................................................. xxixAudience................................................................................................................................................... xxixDocumentation Accessibility ................................................................................................................. xxixRelated Documents ................................................................................................................................. xxixConventions ............................................................................................................................................. xxx

1 Introduction1.1 Document Organization ............................................................................................................ 1-11.2 Whats New ................................................................................................................................. 1-2

2 Idoc Script Application2.1 Idoc Naming Conventions......................................................................................................... 2-12.2 Idoc Script Syntax ....................................................................................................................... 2-22.2.1 Idoc Script Tags.................................................................................................................... 2-22.2.2 Idoc Script Comments......................................................................................................... 2-22.3 Idoc Script Uses ........................................................................................................................... 2-22.3.1 Includes ................................................................................................................................. 2-32.3.1.1 Include Example ........................................................................................................... 2-32.3.1.2 Super Tag ....................................................................................................................... 2-42.3.1.3 Super Tag Example ...................................................................................................... 2-42.3.2 Variables................................................................................................................................ 2-52.3.2.1 Creating a Variable....................................................................................................... 2-52.3.2.2 Referencing a Variable ................................................................................................. 2-52.3.2.3 Assigning a Value......................................................................................................... 2-52.3.2.4 Using Commas as Separators ..................................................................................... 2-62.3.2.5 Referencing a Variable in a Conditional ................................................................... 2-62.3.2.6 Variable Substitution Order........................................................................................ 2-62.3.2.7 Regular Variables ......................................................................................................... 2-62.3.3 Functions............................................................................................................................... 2-62.3.3.1 Personalization Functions ........................................................................................... 2-62.3.4 Conditionals ......................................................................................................................... 2-72.3.4.1 Conditional Example ................................................................................................... 2-82.3.5 Looping ................................................................................................................................. 2-82.3.5.1 ResultSet Looping......................................................................................................... 2-82.3.5.2 ResultSet Looping Example ........................................................................................ 2-9

iv

2.3.5.3 While Looping............................................................................................................... 2-92.3.5.4 While Looping Example .............................................................................................. 2-92.3.5.5 Ending a Loop............................................................................................................ 2-102.3.6 Administration Interface ................................................................................................. 2-102.3.6.1 Workflow Admin ...................................................................................................... 2-102.3.6.2 Web Layout Editor .................................................................................................... 2-102.3.6.3 Batch Loader............................................................................................................... 2-112.3.6.4 Archiver ...................................................................................................................... 2-112.3.6.5 System Properties ...................................................................................................... 2-112.3.6.6 E-mail .......................................................................................................................... 2-112.4 Special Keywords..................................................................................................................... 2-112.4.1 Keywords Versus Functions ........................................................................................... 2-122.4.1.1 exec Keyword............................................................................................................. 2-122.4.1.2 eval Function .............................................................................................................. 2-132.4.1.3 include Keyword ....................................................................................................... 2-132.4.1.4 inc Function ................................................................................................................ 2-132.5 Operators................................................................................................................................... 2-142.5.1 Comparison Operators..................................................................................................... 2-142.5.2 Special String Operators .................................................................................................. 2-142.5.2.1 Wildcards.................................................................................................................... 2-152.5.3 Numeric Operators........................................................................................................... 2-152.5.4 Boolean Operators ............................................................................................................ 2-162.6 Metadata Fields ........................................................................................................................ 2-162.6.1 Metadata Field Naming ................................................................................................... 2-162.6.2 Standard Metadata Fields................................................................................................ 2-172.6.2.1 Common Metadata Fields ........................................................................................ 2-172.6.2.2 Other Fields ................................................................................................................ 2-172.6.3 Option Lists ....................................................................................................................... 2-202.6.3.1 Internal Option Lists ................................................................................................. 2-202.6.3.2 Option List Script....................................................................................................... 2-212.6.3.3 Creating an Option List ............................................................................................ 2-212.6.4 Referencing Metadata in Dynamic Server Pages ......................................................... 2-222.7 Using Merge Includes to Format Responses........................................................................ 2-222.8 Scoped Local Variables ........................................................................................................... 2-24

3 Master List: Idoc Script by Type3.1 Conditional Dynamic Variables................................................................................................ 3-13.2 Configuration Variables............................................................................................................. 3-23.2.1 Content Server Configuration Variables .......................................................................... 3-23.2.1.1 DomainHome/ucm/cs/bin/intradoc.cfg................................................................... 3-33.2.1.2 IntradocDir/config/config.cfg .................................................................................... 3-33.2.1.3 IdcHomeDir/components/folders_g/folders_environment.cfg............................ 3-83.2.1.4 IntradocDir/data/providers/provider_name/provider.hda ................................ 3-83.2.2 Inbound Refinery Configuration Variables ..................................................................... 3-93.2.3 Link Manager Configuration Variables......................................................................... 3-103.2.4 Pop-Up Calendar Configuration Variables .................................................................. 3-103.2.5 Record Manager and Retention Manager Configuration Variables ......................... 3-10

v3.3 Dynamic Variables................................................................................................................... 3-103.4 Environment Variables ........................................................................................................... 3-113.5 Global Functions ...................................................................................................................... 3-113.6 Page Variables .......................................................................................................................... 3-153.6.1 Page Display Variables .................................................................................................... 3-153.6.2 Field Display Variables .................................................................................................... 3-153.6.2.1 Field Information Variables ..................................................................................... 3-153.6.2.1.1 Field Information Variables .............................................................................. 3-163.6.2.2 Common Field Display Variables ........................................................................... 3-163.6.2.2.1 Other Field Display Variables .......................................................................... 3-173.6.2.2.2 Field Display Variables...................................................................................... 3-173.7 Read-Only Variables................................................................................................................ 3-183.7.1 Template Read-Only Variables....................................................................................... 3-183.7.1.1 Template Read-Only Variable Example................................................................. 3-183.7.2 User Read-Only Variables ............................................................................................... 3-193.7.3 Content Read-Only Variables ......................................................................................... 3-193.7.4 Other Read-Only Variables ............................................................................................. 3-193.8 Setable Variables ...................................................................................................................... 3-193.8.1 Workflows.......................................................................................................................... 3-203.8.1.1 Workflow Functions.................................................................................................. 3-213.8.1.2 Workflow Variables .................................................................................................. 3-213.9 Value Variables ........................................................................................................................ 3-21

4 Master List: Idoc Script by Usage4.1 Archiver........................................................................................................................................ 4-24.2 Batch Loader ................................................................................................................................ 4-24.3 Clients ........................................................................................................................................... 4-24.4 Content Items .............................................................................................................................. 4-34.5 Content Profiles........................................................................................................................... 4-34.6 Content Server ............................................................................................................................. 4-44.7 Conversion ................................................................................................................................... 4-54.7.1 Inbound Refinery................................................................................................................. 4-64.7.2 PDF Converter...................................................................................................................... 4-64.7.2.1 General Variables ......................................................................................................... 4-64.7.2.2 Microsoft Office ............................................................................................................ 4-64.7.2.3 InDesign ......................................................................................................................... 4-74.7.2.4 Other Formats ............................................................................................................... 4-74.7.3 Dynamic Converter ............................................................................................................. 4-74.8 Database ....................................................................................................................................... 4-84.9 Date and Time ............................................................................................................................. 4-84.10 Debugging.................................................................................................................................... 4-94.11 Directories and Paths.................................................................................................................. 4-94.12 Dynamicdata............................................................................................................................. 4-104.13 Field Display............................................................................................................................. 4-114.14 Folders and WebDAV ............................................................................................................. 4-124.15 HTML Preview......................................................................................................................... 4-124.16 Idoc Script ................................................................................................................................. 4-12

vi

4.16.1 Keywords ........................................................................................................................... 4-134.17 Indexing..................................................................................................................................... 4-134.18 JSP............................................................................................................................................... 4-134.19 Localization............................................................................................................................... 4-134.20 Page Display ............................................................................................................................. 4-144.21 Personalization ......................................................................................................................... 4-154.22 Pop-Up Calendar ..................................................................................................................... 4-154.23 Record Manager and Retention Manager ............................................................................ 4-154.24 ResultSets .................................................................................................................................. 4-154.25 Schema....................................................................................................................................... 4-164.25.1 Schema publish settings................................................................................................... 4-164.26 Searching ................................................................................................................................... 4-174.27 Security ...................................................................................................................................... 4-184.27.1 Internal Security................................................................................................................ 4-184.27.2 External Security ............................................................................................................... 4-194.28 Strings ........................................................................................................................................ 4-194.29 Templates .................................................................................................................................. 4-204.30 Users .......................................................................................................................................... 4-204.31 Web Server ................................................................................................................................ 4-214.32 Workflow .................................................................................................................................. 4-214.32.1 Configuration Variables................................................................................................... 4-214.32.2 Global Functions ............................................................................................................... 4-214.32.3 Workflow Functions......................................................................................................... 4-224.32.4 Other Variables ................................................................................................................. 4-22

5 Core Functions by Type and Usage5.1 Conditional Dynamic Variables................................................................................................ 5-15.2 Configuration Variables............................................................................................................. 5-25.2.1 DomainHome/ucm/product_id/bin/intradoc.cfg............................................................ 5-25.2.2 IntradocDir/config/config.cfg............................................................................................ 5-25.2.3 DomainDir/ucm/short_product_id/data/providers/provider_name/provider.hda... 5-55.3 Environment Variables .............................................................................................................. 5-55.4 Global Functions ......................................................................................................................... 5-55.5 Setable Variables ......................................................................................................................... 5-65.5.1 Workflows............................................................................................................................. 5-65.6 Value Variables ........................................................................................................................... 5-75.7 Content Items .............................................................................................................................. 5-85.8 Content Server ............................................................................................................................. 5-85.9 Database ....................................................................................................................................... 5-95.10 Indexing..................................................................................................................................... 5-105.11 Schema....................................................................................................................................... 5-105.11.1 Schema publish settings................................................................................................... 5-105.12 Searching ................................................................................................................................... 5-115.13 Security ...................................................................................................................................... 5-125.13.1 Internal Security................................................................................................................ 5-125.13.2 External Security ............................................................................................................... 5-125.14 Web Server ................................................................................................................................ 5-13

vii

5.15 Workflow .................................................................................................................................. 5-145.15.1 Configuration Variables................................................................................................... 5-145.15.2 Workflow Functions......................................................................................................... 5-145.15.3 Other Variables ................................................................................................................. 5-14

6 Core Content Server Variables and FunctionsAdditionalIndexBuildParams ................................................................................................... 6-2AdditionalSubscriptionCollatedFieldList ............................................................................... 6-4AdminAtLeastOneGroup .......................................................................................................... 6-5AllowCheckin.............................................................................................................................. 6-6AllowCheckout............................................................................................................................ 6-7AllowAllRedirectUrls................................................................................................................. 6-8AllowAlternateMetaFile ............................................................................................................ 6-9AllowConcurrentUpdate ........................................................................................................ 6-10AllowPrimaryMetaFile............................................................................................................ 6-11AllowReview ............................................................................................................................ 6-12AllowSamePrimaryAlternateExtensions.............................................................................. 6-13AppletChunkSize..................................................................................................................... 6-14AppletChunkThreshold.......................................................................................................... 6-15AuthorDelete ............................................................................................................................ 6-16AutoNumberPrefix .................................................................................................................. 6-17AutoNumberWidth ................................................................................................................. 6-18CachedResultRowCount......................................................................................................... 6-19clearSchemaData ...................................................................................................................... 6-20ColumnMapFile ....................................................................................................................... 6-21computeDocUrl ........................................................................................................................ 6-22computeRenditionUrl.............................................................................................................. 6-23CONTENT_LENGTH ............................................................................................................. 6-24CookieAuthTimeoutInDays ................................................................................................... 6-25CookieProxyPassword ............................................................................................................ 6-26createAlternateMetaFile.......................................................................................................... 6-27createPrimaryMetaFile ............................................................................................................ 6-28DatabasePreserveCase............................................................................................................. 6-29DatabaseWildcards .................................................................................................................. 6-30Default Accounts...................................................................................................................... 6-31DefaultHtmlRefreshTimeoutInSeconds ............................................................................... 6-32DefaultPasswordEncoding ..................................................................................................... 6-33DisableDBLongIntegerField ................................................................................................... 6-34DisableGzipCompression ....................................................................................................... 6-35DisableHttpUploadChunking................................................................................................ 6-36DocTypeSelected...................................................................................................................... 6-37DocUrl........................................................................................................................................ 6-38

viii

docUrlAllowDisclosure........................................................................................................... 6-39DoDocNameOrder................................................................................................................... 6-40DomainControllerName ......................................................................................................... 6-41dWfName.................................................................................................................................. 6-42dWfStepName .......................................................................................................................... 6-43EmptyAccountCheckinAllowed............................................................................................ 6-44EnableDocumentHighlight..................................................................................................... 6-45EnableExpirationNotifier........................................................................................................ 6-46EnableSchemaPublish ............................................................................................................. 6-48encodeHtml............................................................................................................................... 6-49entryCount ................................................................................................................................ 6-50ExclusiveCheckout................................................................................................................... 6-51ExpireRevisionOnly................................................................................................................. 6-52fileUrl ......................................................................................................................................... 6-53FIRSTREV.................................................................................................................................. 6-54ForceDistinctRevLabels........................................................................................................... 6-55ForceJdbcSync........................................................................................................................... 6-56formatDateDatabase ................................................................................................................ 6-57FormInheritMetaDataFieldList .............................................................................................. 6-58GATEWAY_INTERFACE....................................................................................................... 6-59getCookie................................................................................................................................... 6-60GetCopyAccess......................................................................................................................... 6-61getFieldConfigValue................................................................................................................ 6-62getFieldViewDisplayValue..................................................................................................... 6-63getParentValue ......................................................................................................................... 6-64getViewValue ........................................................................................................................... 6-65getViewValueResultSet........................................................................................................... 6-66hasAppRights ........................................................................................................................... 6-67HasExternalUsers..................................................................................................................... 6-68HasOriginal............................................................................................................................... 6-69HasPredefinedAccounts ......................................................................................................... 6-70HasUrl........................................................................................................................................ 6-71HtmlDataInputFilterLevel ...................................................................................................... 6-72HTTP_ACCEPT........................................................................................................................ 6-73HTTP_ACCEPT_ENCODING ............................................................................................... 6-74HTTP_ACCEPT_LANGUAGE .............................................................................................. 6-75HTTP_COOKIE ........................................................................................................................ 6-76HTTP_HOST............................................................................................................................. 6-77HTTP_INTERNETUSER ......................................................................................................... 6-78HTTP_REFERER ...................................................................................................................... 6-79HTTP_USER_AGENT ............................................................................................................. 6-80HttpIgnoreWebServerInternalPortNumber......................................................................... 6-81

ix

IDC_Name ................................................................................................................................ 6-82IdcAuthExtraRequestParams................................................................................................. 6-83IdcCommandFile...................................................................................................................... 6-84IdcCommandLog ..................................................................................................................... 6-85IdcCommandServerHost ........................................................................................................ 6-86IdcCommandUser.................................................................................................................... 6-87IdcHttpHeaderVariables......................................................................................................... 6-88IndexableRenditions................................................................................................................ 6-89IndexerAutoWorkInterval ...................................................................................................... 6-90IndexerLargeFileSize ............................................................................................................... 6-91IndexerRebuildStagingManualCopy .................................................................................... 6-92IndexerRebuildStagingPath ................................................................................................... 6-93indexerSetCollectionValue ..................................................................................................... 6-94IndexerTouchMonitorInterval ............................................................................................... 6-95IndexerTraceCycleListChanges ............................................................................................. 6-96IndexerTraceLockFileChanges............................................................................................... 6-97IndexerTraceStartStop............................................................................................................. 6-98InstanceDescription ................................................................................................................. 6-99InstanceMenuLabel................................................................................................................ 6-100IntradocRealm ........................................................................................................................ 6-101IntradocServerHostName..................................................................................................... 6-102IntradocServerPort................................................................................................................. 6-103IsAllowIndexRenditions ....................................................................................................... 6-104IsAutoNumber ....................................................................................................................... 6-105IsAutoSearch........................................................................................................................... 6-106IsCheckinPreAuthed ............................................................................................................. 6-107isComponentEnabled ........................................................................................................... 6-108IsContributor ......................................................................................................................... 6-109IsCriteriaSubscription............................................................................................................ 6-110IsEditRev ................................................................................................................................. 6-111IsFailedIndex .......................................................................................................................... 6-112IsFilePresent............................................................................................................................ 6-113IsFormsPresent ....................................................................................................................... 6-114IsFullTextIndexed .................................................................................................................. 6-115IsJdbcLockTrace ..................................................................................................................... 6-116IsJdbcQueryTrace................................................................................................................... 6-117isLayoutEnabled..................................................................................................................... 6-118IsLocalSearchCollectionID.................................................................................................... 6-119IsLoggedIn .............................................................................................................................. 6-120IsNotLatestRev ....................................................................................................................... 6-121IsNotSyncRev ......................................................................................................................... 6-122

xIsPrimaryUserBase................................................................................................................. 6-123IsPromptingForLogin ............................................................................................................ 6-124isRepromptLogin ................................................................................................................... 6-125IsSavedWfCompanionFile .................................................................................................... 6-126IsSubAdmin ............................................................................................................................ 6-127IsSysManager.......................................................................................................................... 6-128IsUploadSockets ..................................................................................................................... 6-129isUserOverrideSet .................................................................................................................. 6-130isValidateFile .......................................................................................................................... 6-131IsWebServerPagesOnly......................................................................................................... 6-132IsWorkflow ............................................................................................................................. 6-133isZoneSearchField.................................................................................................................. 6-134JdbcConnectionString............................................................................................................ 6-135JdbcDriver ............................................................................................................................... 6-136JdbcPassword ......................................................................................................................... 6-137JdbcPasswordEncoding ........................................................................................................ 6-138JdbcUser .................................................................................................................................. 6-139jsFilename ............................................................................................................................... 6-140lastEntryTs .............................................................................................................................. 6-141LdapAdminDN ...................................................................................................................... 6-142LdapAdminPassword ........................................................................................................... 6-143LdapPort.................................................................................................................................. 6-144LdapServer.............................................................................................................................. 6-145LdapSuffix............................................................................................................................... 6-146LkDisableOnRebuild ............................................................................................................. 6-147LkDisableReferenceInfo ........................................................................................................ 6-148LkDisallowConversionFormats ........................................................................................... 6-149LkIsSecureSearch ................................................................................................................... 6-150LkReExtractOnRebuild ......................................................................................................... 6-151LkRefreshBatchSize ............................................................................................................... 6-152LkRefreshErrorPercent.......................................................................................................... 6-153LkRefreshErrorsAllowed...................................................................................................... 6-154LkRefreshErrorThreshold..................................................................................................... 6-155LmDefaultLayout................................................................................................................... 6-156LmDefaultSkin ....................................................................................................................... 6-157lmGetLayout .......................................................................................................................... 6-158lmGetSkin ............................................................................................................................... 6-159loadCollectionInfo ................................................................................................................. 6-160loadSchemaData .................................................................................................................... 6-161MailServer ............................................................................................................................... 6-162MajorRevSeq........................................................................................................................... 6-163MaxCollectionSize ................................................................................................................. 6-164

xi

MaxDocIndexErrors .............................................................................................................. 6-165MaxHitCount.......................................................................................................................... 6-166MaxIntegerAllowed............................................................................................................... 6-167MaxQueryRows ..................................................................................................................... 6-168MaxRequestThreadCount .................................................................................................... 6-169MaxResults.............................................................................................................................. 6-170MaxSavedSearchResults ....................................................................................................... 6-171MaxSearchConnections......................................................................................................... 6-172MaxSizeResourceFileCacheMillions ................................................................................... 6-173MaxStandardDatabaseResults ............................................................................................. 6-174MemoFieldSize ....................................................................................................................... 6-175MinIntegerAllowed ............................................................................................................... 6-176MinMemoFieldSize................................................................................................................ 6-177MinorRevSeq .......................................................................................................................... 6-178NoAutomation ....................................................................................................................... 6-179NoMatches .............................................................................................................................. 6-180NoSearchConnectionCloseOnDocChange......................................................................... 6-181NotificationIntervalInDays................................................................................................... 6-182NotificationMaximum........................................................................................................... 6-183NotificationQuery .................................................................................................................. 6-184NotifyExtras............................................................................................................................ 6-185NotifyTime.............................................................................................................................. 6-186NtlmSecurityEnabled ............................................................................................................ 6-187NumConnections ................................................................................................................... 6-188OneMatch................................................................................................................................ 6-189PATH_INFO ........................................................................................................................... 6-190PATH_TRANSLATED.......................................................................................................... 6-191PLUGIN_DEBUG................................................................................................................... 6-192PrimaryWorkQueueTimeout ............................................................................................... 6-193Priority..................................................................................................................................... 6-194ProviderClass.......................................................................................................................... 6-195ProviderConfig....................................................................................................................... 6-196ProviderConnection............................................................................................................... 6-197ProviderType.......................................................................................................................... 6-198QUERY_STRING ................................................................................................................... 6-199RedirectHostsFilter ................................................................................................................ 6-200regexMatches .......................................................................................................................... 6-201regexReplaceAll ..................................................................................................................... 6-202regexReplaceFirst ................................................................................................................... 6-203REMOTE_ADDR.................................................................................................................... 6-204REMOTE_HOST..................................................................................................................... 6-205

xii

REQUEST_METHOD............................................................................................................ 6-206ResultsTitle.............................................................................................................................. 6-207SchemaAllowRecursiveFileMove........................................................................................ 6-208SchemaBuildDigestFile ......................................................................................................... 6-209SchemaPublishCheckInterval .............................................................................................. 6-210SchemaPublishInterval.......................................................................................................... 6-211SchemaPublishMaximumInterval ....................................................................................... 6-212SchemaPublishMinimumInterval........................................................................................ 6-213SchemaPublishRenameRetryInitialInterval ....................................................................... 6-214SchemaPublishRenameRetryIterations............................................................................... 6-215SchemaPublishRetryInterval................................................................................................ 6-216SchemaPublishRetryIntervalMax ........................................................................................ 6-217SchemaVerifyPublishing....................................................................................................... 6-218SchemaWin32RenameDelayInterval................................................................................... 6-219SCRIPT_NAME...................................................................................................................... 6-220SearchCacheCleanerInterval ................................................................................................ 6-221SearchCacheHardLimit ......................................................................................................... 6-222SearchCacheMaxItemAgeInMinutes .................................................................................. 6-223SearchCacheSoftLimit ........................................................................................................... 6-224SearchCacheTrace .................................................................................................................. 6-225SearchConnectionWaitTimeout ........................................................................................... 6-226SearchDebugLevel ................................................................................................................. 6-227SearchDir ................................................................................................................................. 6-228SearchIndexerEngineName.................................................................................................. 6-229SearchQueryFormat............................................................................................................... 6-230SearchQueryTrace.................................................................................................................. 6-231SelfRegisteredAccounts......................................................................................................... 6-232SelfRegisteredRoles ............................................................................................................... 6-233SERVER_NAME..................................................................................................................... 6-234SERVER_PORT....................................................................................................................... 6-235SERVER_PROTOCOL ........................................................................................................... 6-236SERVER_SOFTWARE ........................................................................................................... 6-237ServiceStartupTimeout.......................................................................................................... 6-238setCookie ................................................................................................................................. 6-239ShowCreateExternalMenu.................................................................................................... 6-240ShowOnlyKnownAccounts .................................................................................................. 6-241SingleGroup............................................................................................................................ 6-242SkipMozillaMailToWorkaround ......................................................................................... 6-243SmtpPort.................................................................................................................................. 6-244SocketHostAddressSecurityFilter........................................................................................ 6-245SocketHostNameSecurityFilter............................................................................................ 6-246SourceID .................................................................................................................................. 6-247

xiii

SourcePath .............................................................................................................................. 6-248StatusCode .............................................................................................................................. 6-249StatusMessage ........................................................................................................................ 6-250stdSecurityCheck ................................................................................................................... 6-251SubscriptionCollatedFieldList.............................................................................................. 6-252SubscriptionMethod .............................................................................................................. 6-253TextIndexerFilterValidateFormats ...................................................................................... 6-254TimeoutPerOneMegInSec..................................................................................................... 6-255UieHideSearchCheckboxes................................................................................................... 6-256UniversalSearchAllowFullText............................................................................................ 6-257UseAccounts ........................................................................................................................... 6-258UseAdsi ................................................................................................................................... 6-259UseDatabaseShortIndexName ............................................................................................. 6-260UseHtmlOrTextHighlightInfo.............................................................................................. 6-261UseNetscape ........................................................................................................................... 6-262UseNtlm .................................................................................................................................. 6-263UseRevisionCreateDate ........................................................................................................ 6-264UserFilteredSubjects .............................................................................................................. 6-265userHasAccessToAccount .................................................................................................... 6-266userHasGroupPrivilege ........................................................................................................ 6-267userHasRole............................................................................................................................ 6-268UserIsAdmin........................................................................................................................... 6-269UseSearchCache ..................................................................................................................... 6-270UseSecureLdap....................................................................................................................... 6-271UseSSL ..................................................................................................................................... 6-272UseXmlUrl............................................................................................................................... 6-273WebServerAuthOnly ............................................................................................................. 6-274wfAction.................................................................................................................................. 6-275wfAddActionHistoryEvent .................................................................................................. 6-276wfAdditionalExitCondition.................................................................................................. 6-277wfAddUser ............................................................................................................................. 6-278wfComputeStepUserList....................................................................................................... 6-279wfCurrentGet.......................................................................................................................... 6-280wfCurrentSet........................................................................................................................... 6-281wfCurrentStep ........................................................................................................................ 6-282wfDisplayCondition .............................................................................................................. 6-283wfExit....................................................................................................................................... 6-284wfGet........................................................................................................................................ 6-285wfGetStepTypeLabel ............................................................................................................ 6-286wfIsFinishedDocConversion ................................................................................................ 6-287wfIsNotifyingUsers................................................................................................................ 6-288

xiv

wfIsReleasable ....................................................................................................................... 6-289wfJumpEntryNotifyOff ......................................................................................................... 6-290wfJumpMessage..................................................................................................................... 6-291wfJumpName ......................................................................................................................... 6-292wfJumpReturnStep ................................................................................................................ 6-293wfJumpTargetStep................................................................................................................. 6-294wfLoadDesign ........................................................................................................................ 6-295wfMailSubject ......................................................................................................................... 6-296wfMessage............................................................................................................................... 6-297wfNotify .................................................................................................................................. 6-298wfParentList............................................................................................................................ 6-299wfReleaseDocument ............................................................................................................. 6-300wfSet ........................................................................................................................................ 6-301wfSetIsNotifyingUsers .......................................................................................................... 6-302WfStart..................................................................................................................................... 6-303wfUpdateMetaData ............................................................................................................... 6-304WorkflowDir........................................................................................................................... 6-305WorkflowIntervalHours ....................................................................................................... 6-306XMLEncodingMode .............................................................................................................. 6-307

7 Management and Configuration Options by Type and Usage7.1 Conditional Dynamic Variables................................................................................................ 7-27.2 Configuration Variables............................................................................................................. 7-27.3 Global Functions ......................................................................................................................... 7-47.4 Page Variables ............................................................................................................................. 7-67.4.1 Page Display Variables ....................................................................................................... 7-67.4.2 Field Display Variables ....................................................................................................... 7-77.4.2.1 Field Information Variables ........................................................................................ 7-77.4.2.2 Common Field Display Variables .............................................................................. 7-77.4.2.3 Other Field Display Variables..................................................................................... 7-77.5 Read-Only Variables................................................................................................................... 7-87.5.1 Template Read-Only Variables.......................................................................................... 7-87.5.2 User Read-Only Variables .................................................................................................. 7-87.5.3 Other Read-Only Variables ................................................................................................ 7-87.6 Setable Variables ......................................................................................................................... 7-97.7 Value Variables ........................................................................................................................... 7-97.8 Archiver........................................................................................................................................ 7-97.9 Batch Loader ................................................................................................................................ 7-97.10 Clients ........................................................................................................................................ 7-107.11 Content Profiles........................................................................................................................ 7-107.12 Date and Time .......................................................................................................................... 7-107.13 Debugging................................................................................................................................. 7-117.14 Directories and Paths............................................................................................................... 7-117.15 Dynamichtml ............................................................................................................................ 7-12

xv

7.16 Field Display............................................................................................................................. 7-127.17 Idoc Script ................................................................................................................................. 7-137.18 JSP............................................................................................................................................... 7-147.19 Localization............................................................................................................................... 7-147.20 Page Display ............................................................................................................................. 7-147.21 Personalization ......................................................................................................................... 7-157.22 ResultSets .................................................................................................................................. 7-157.23 Strings ........................................................................................................................................ 7-167.24 Templates .................................................................................................................................. 7-177.25 Users .......................................................................................................................................... 7-17

8 Management and Configuration Variables and FunctionsabortToErrorPage........................................................................................................................ 8-2AccessListPrivilegesGrantedWhenEmpty .............................................................................. 8-3addEmptyOption ........................................................................................................................ 8-4AfterLogin.................................................................................................................................... 8-5AllowMatchesInDateCheck....................................................................................................... 8-6ARCHIVE_COLLECTION ........................................................................................................ 8-7ArchiverDoLocks ........................................................................................................................ 8-8ArchiverTouchMonitorInterval ................................................................................................ 8-9ArchiverTraceLockMaintenance............................................................................................ 8-10ArchiverTraceLocks................................................................................................................. 8-11AuthorAddress......................................................................................................................... 8-12BatchLoaderPath ...................................................................................................................... 8-13BatchLoaderUserName........................................................................................................... 8-14BinDir......................................................................................................................................... 8-15break........................................................................................................................................... 8-16BrowserVersionNumber ......................................................................................................... 8-17c................................................................................................................................................... 8-18cacheInclude ............................................................................................................................. 8-19captionEntryWidth .................................................................................................................. 8-20captionFieldWidth ................................................................................................................... 8-21ChunkedRequestTrace ............................................................................................................ 8-22CleanUp..................................................................................................................................... 8-23ClientControlled....................................................................................................................... 8-24CollectionLocation ................................................................................................................... 8-25ConfigDir................................................................................................................................... 8-26coreContentOnly ...................................................................................................................... 8-27CURRENT_DATE.................................................................................................................... 8-28CURRENT_ROW ..................................................................................................................... 8-29DataDir ...................................................................................................................................... 8-30dateCurrent............................................................................................................................... 8-31

xvi

DateOutputFormat .................................................................................................................. 8-32ddAppendIndexedColumnResultSet.................................................................................... 8-33ddAppendResultSet ................................................................................................................ 8-35ddApplyTableSortToResultSet .............................................................................................. 8-36ddGetFieldList.......................................................................................................................... 8-37ddIncludePreserveValues....................................................................................................... 8-38ddLoadIndexedColumnResultSet ......................................................................................... 8-40ddLoadResultSet ...................................................................................................................... 8-41ddMergeIndexedColumnResultSet....................................................................................... 8-42ddMergeResultSet.................................................................................................................... 8-44ddMergeUsingIndexedKey .................................................................................................... 8-46ddSetLocal................................................................................................................................. 8-48ddSetLocalByColumnsFromFirstRow .................................................................................. 8-49ddSetLocalByColumnsFromFirstRowIndexed.................................................................... 8-50ddSetLocalEmpty..................................................................................................................... 8-51ddSetLocalEmptyByColumns ................................................................................................ 8-52defaultFieldInclude.................................................................................................................. 8-53defaultOptionListScript .......................................................................................................... 8-54DelimitedUserRoles................................................................................................................. 8-55DirectoryLockingLogPath ...................................................................................................... 8-56DisableContentProfiles............................................................................................................ 8-57DisableGzipCompression ....................................................................................................... 8-58DisableSharedCacheChecking ............................................................................................... 8-59docLoadResourceIncludes...................................................................................................... 8-60docRootFilename ..................................................................................................................... 8-62DownloadApplet ..................................................................................................................... 8-63DownloadSuggestedName..................................................................................................... 8-64dpGet ......................................................................................................................................... 8-65dpPromote................................................................................................................................. 8-66dpPromoteRs ............................................................................................................................ 8-67dpSet .......................................................................................................................................... 8-68EnableEnvironmentPackager................................................................................................. 8-69EnableErrorFile......................................................................................................................... 8-70eval ............................................................................................................................................. 8-71exec............................................................................................................................................. 8-72executeService .......................................................................................................................... 8-73ExternalUserAccounts............................................................................................................. 8-74ExternalUserRoles.................................................................................................................... 8-75fieldCaption .............................................................................................................................. 8-76fieldCaptionInclude................................................................................................................. 8-77fieldCaptionStyle...................................................................................................................... 8-78fieldDefault ............................................................................................................................... 8-79

xvii

fieldEditWidth.......................................................................................................................... 8-80fieldEntryInclude ..................................................................................................................... 8-81fieldExtraScriptInclude ........................................................................................................... 8-82fieldInclude ............................................................................................................................... 8-83fieldIsOptionList ...................................................................................................................... 8-84fieldMaxLength ........................................................................................................................ 8-85fieldName.................................................................................................................................. 8-86fieldOptionListType ................................................................................................................ 8-87fieldType ................................................................................................................................... 8-88fieldValue .................................................................................................................................. 8-89fieldValueStyle ......................................................................................................................... 8-90fieldWidth ................................................................................................................................. 8-91FileEncoding ............................................................................................................................. 8-92ForceDocTypeChoice............................................................................................................... 8-93forceExpire ................................................................................................................................ 8-94ForceSecurityGroupChoice .................................................................................................... 8-96formatDate ................................................................................................................................ 8-97formatDateDisplay .................................................................................................................. 8-98formatDateOnly ....................................................................................................................... 8-99formatDateOnlyDisplay........................................................................................................ 8-100formatDateOnlyFull .............................................................................................................. 8-101formatDateWithPattern......................................................................................................... 8-102formatTimeOnly..................................................................................................................... 8-103formatTimeOnlyDisplay....................................................................................................... 8-104generateUniqueId .................................................................................................................. 8-105getDebugTrace ....................................................................................................................... 8-106getErrorTrace .......................................................................................................................... 8-107getFieldViewValue ................................................................................................................ 8-108getFreeMemory ...................................................................................................................... 8-109getHelpPage............................................................................................................................ 8-110getOptionListSize................................................................................................................... 8-111getRequiredMsg ..................................................................................................................... 8-112getTextFile............................................................................................................................... 8-113getTotalMemory..................................................................................................................... 8-114getUserValue .......................................................................................................................... 8-115getValue................................................................................................................................... 8-116getValueForSpecifiedUser .................................................................................................... 8-118HasLocalCopy ...................