7 Management and Configuration Options by Type and Usage

This chapter describes the Idoc Script variables and functions used to manage and configure the Oracle Content Server system, and groups the variables and functions by type.

Section 7.1, "Conditional Dynamic Variables"
Section 7.2, "Configuration Variables"
Section 7.3, "Global Functions"
Section 7.4, "Page Variables"
Section 7.5, "Read-Only Variables"
Section 7.6, "Setable Variables"
Section 7.7, "Value Variables"

This chapter also groups Idoc Script variables and functions by common usage.

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"

7.1 Conditional Dynamic Variables

Some dynamic variables are conditional and can only be used within a conditional statement such as if, while, elseif, or loop. For a list of conditional dynamic variables and details about their use, see Section 3.1, "Conditional Dynamic Variables."

The following is a list of Idoc Script conditional dynamic variables relating to configuration.

"AfterLogin"
"HeavyClient"
"IsDynamic"
"IsExternalUser"
"IsMac"
"IsMaxRows"
"IsSun"
"IsUserEmailPresent"
"IsWindows"
"UserLanguageID"
"UserLocaleId"

7.2 Configuration Variables

The following configuration variables are used when customizing and configuring the Oracle Content Server system.

"AccessListPrivilegesGrantedWhenEmpty"
"AllowMatchesInDateCheck"
"ARCHIVE_COLLECTION"
"ArchiverDoLocks"
"ArchiverTouchMonitorInterval"
"ArchiverTraceLockMaintenance"
"ArchiverTraceLocks"
"BatchLoaderPath"
"BatchLoaderUserName"
"BinDir"
"ChunkedRequestTrace"
"CleanUp"
"CollectionLocation"
"ConfigDir"
"DataDir"
"DateOutputFormat"
"DisableSharedCacheChecking"
"DirectoryLockingLogPath"
"DownloadApplet"
"EnableEnvironmentPackager"
"EnableErrorFile"
"FileEncoding"
"ForceDocTypeChoice"
"ForceSecurityGroupChoice"
"getFreeMemory"
"getTotalMemory"
"HTMLEditorPath"
"IdcAnalyzeLogDir"
"lcCaption"
"IdcLocale"
"IdcServerBindAddress"
"IdcServerSocketQueueDepth"
"IntradocDir"
"isActiveTrace"
"IsAutoArchiver"
"IsJspServerEnabled"
"IsOverrideFormat"
"isPhysicallySplitDir"
"isVerboseTrace"
"IsXml"
"JspAdminQuery"
"JspDefaultIndexPage"
"JspEnabledGroups"
"LocaleArchiverDateFormat"
"LogMessagePrefix"
"LogName"
"MaxArchiveErrorsAllowed"
"MaxErrorsAllowed"
"MacSupportsSignedApplets"
"MultiUpload"
"NotationForRequiredFields"
"OdbcDateFormat"
"ProviderDir"
"RequestAuditAdditionalVerboseFieldsList"
"RequestAuditIntervalSeconds1"
"RequestAuditIntervalSeconds2"
"RequestAuditListDepth1"
"RequestAuditListDepth2"
"RequestAuditSubClassificationField"
"rptDisplayMapValue"
"SearchDir"
"showDocActions"
"ShowRevisionsColumn"
"StrConfineOverflowChars"
"StyleForRequiredFields"
"SubjectsDir"
"SysAdminAddress"
"SystemDateFormat"
"SystemLocale"
"SystemTimeZone"
"TempDir"
"TraceResourceConflict"
"TraceResourceLoad"
"TraceResourceOverride"
"UseFourDigitYear"
"UploadApplet"
"UserCache"
"UserCacheTimeout"
"UserLanguageID"
"UserLocaleId"
"UserPublishCacheDir"
"UseRedirectedOutput"
"WarnAboutTimeZone"
"WebBrowserPath"
"WeblayoutDir"

7.3 Global Functions

Idoc Script has many built-in global functions. For a list of conditional dynamic variables and details about their use, see Section 3.5, "Global Functions."

The following is a list of Idoc Script global functions relating to configuration and usage.

"abortToErrorPage"
"break"
"cacheInclude"
"dateCurrent"
"ddAppendIndexedColumnResultSet"
"ddAppendResultSet"
"ddApplyTableSortToResultSet"
"ddGetFieldList"
"ddIncludePreserveValues"
"ddLoadIndexedColumnResultSet"
"ddLoadResultSet"
"ddMergeIndexedColumnResultSet"
"ddMergeResultSet"
"ddMergeUsingIndexedKey"
"ddSetLocal"
"ddSetLocalByColumnsFromFirstRow"
"ddSetLocalByColumnsFromFirstRowIndexed"
"ddSetLocalEmpty"
"ddSetLocalEmptyByColumns"
"docLoadResourceIncludes"
"docRootFilename"
"dpGet"
"dpPromote"
"dpPromoteRs"
"dpSet"
"eval"
"executeService"
"forceExpire"
"formatDate"
"formatDateDisplay"
"formatDateOnly"
"formatDateOnlyDisplay"
"formatDateOnlyFull"
"formatDateWithPattern"
"formatTimeOnly"
"formatTimeOnlyDisplay"
"getDebugTrace"
"getErrorTrace"
"getFieldViewValue"
"getFreeMemory"
"getRequiredMsg"
"getTextFile"
"getTotalMemory"
"getUserValue"
"getValue"
"idocTestForInclude"
"inc"
"incGlobal"
"incTemplate"
"isActiveTrace"
"isFalse"
"isTrue"
"js"
"lc"
"lcCaption"
"loadDocMetaDefinition"
"loadDocumentProfile"
"loadSearchOperatorTables"
"loadUserMetaDefinition"
"optList"
"parseDataEntryDate"
"parseDateWithPattern"
"pneNavigation"
"rptDisplayMapValue"
"rs"
"rsAddFields"
"rsAddFieldsWithDefaults"
"rsAddRowCountColumn"
"rsAppend"
"rsAppendNewRow"
"rsAppendRowvalues"
"rsCopyFiltered"
"rsCreateReference"
"rsCreateResultSet"
"rsDeleteRow"
"rsExists"
"rsFieldByIndex"
"rsFieldExists"
"rsFindRowPrimary"
"rsFirst"
"rsInsertNewRow"
"rsIsRowPresent"
"rsLoopInclude"
"rsLoopSingleRowInclude"
"rsMakeFromList"
"rsMakeFromString"
"rsMerge"
"rsMergeDelete"
"rsMergeReplaceOnly"
"rsNext"
"rsNumFields"
"rsNumRows"
"rsRemove"
"rsRename"
"rsRenameField"
"rsSetRow"
"rsSort"
"rsSortTree"
"setContentType"
"setExpires"
"setHttpHeader"
"setMaxAge"
"setValue"
"setResourceInclude"
"strCenterPad"
"strCommaAppendNoDuplicates"
"strConfine"
"strEquals"
"strEqualsIgnoreCase"
"strGenerateRandom"
"strIndexOf"
"strLeftFill"
"strLeftPad"
"strLength"
"strLower"
"strRemoveWs"
"strReplace"
"strReplaceIgnoreCase"
"strRightFill"
"strRightPad"
"strSubstring"
"strTrimWs"
"strUpper"
"toInteger"
"trace"
"url"
"urlEscape7Bit"
"utGetValue"
"utLoad"
"utLoadDocumentProfiles"
"utLoadResultSet"
"xml"

7.4 Page Variables

Page variables are set on a particular Oracle Content Server web page to enable specific page attributes or functionality. For details about page display variables, see Section 3.6, "Page Variables."

This section includes these topics:

Section 7.4.1, "Page Display Variables"
Section 7.4.2, "Field Display Variables"

7.4.1 Page Display Variables

The following is a list of Idoc Script page display variables.

"generateUniqueId"
"isCheckin"
"isDocPage"
"isEditMode"
"isFormSubmit"
"isInfo"
"isQuery"
"isUpdate"
"isUploadFieldScript"
"localPageType"
"noMCPrefill"

7.4.2 Field Display Variables

Field display variables can be grouped into the following types:

Section 7.4.2.1, "Field Information Variables"
Section 7.4.2.2, "Common Field Display Variables"
Section 7.4.2.3, "Other Field Display Variables"

For details about these variables, see Section 3.6.2, "Field Display Variables."

7.4.2.1 Field Information Variables

The following variables define information about a metadata field. The variable values are loaded or computed for each metadata field.

"fieldCaption"
"fieldDefault"
"fieldIsOptionList"
"fieldName"
"fieldOptionListType"
"fieldType"
"fieldValue"
"fieldWidth"
"isRequired"
"requiredMsg"
"valueStyle"

7.4.2.2 Common Field Display Variables

There are several commonly used page variables that affect the display of metadata fields on Oracle Content Server pages.

The following is a list of the common field display variables.

"isExcluded"
"isHidden"
"isInfoOnly"
"isRelocated"
"maxLength"
"optionListScript"

7.4.2.3 Other Field Display Variables

Several other variables are available to affect the display of metadata fields.

"addEmptyOption"
"captionEntryWidth"
"captionFieldWidth"
"defaultFieldInclude"
"defaultOptionListScript"
"fieldCaptionInclude"
"fieldCaptionStyle"
"fieldEditWidth"
"fieldEntryInclude"
"fieldExtraScriptInclude"
"fieldInclude"
"fieldMaxLength"
"fieldValueStyle"
"hasOptionList"
"isFieldExcluded"
"isFieldHidden"
"isFieldInfoOnly"
"isFieldMemo"
"isMultiOption"
"isStrictList"
"NotationForRequiredFields"
"optionListKey"
"optionListName"
"optionListResultSet"
"optionListValueInclude"
"optionsAllowPreselect"
"StyleForRequiredFields"

7.5 Read-Only Variables

Read-only variables can be used to gather information about the current template, the user who is currently logged in, or other current settings. These variables are read-only and cannot be assigned a value.

Section 7.5.1, "Template Read-Only Variables"
Section 7.5.2, "User Read-Only Variables"
Section 7.5.3, "Other Read-Only Variables"

7.5.1 Template Read-Only Variables

Template-related read-only variables make it possible to create conditional content in a template based on the identity of the template. For details and a list of all template read-only variables, see Section 3.7.1, "Template Read-Only Variables."

"TemplateClass"
"TemplateFilePath"
"TemplateName"
"TemplateType"

7.5.2 User Read-Only Variables

User-related read-only variables make it possible to gather information about the current user.

"UserAddress"
"UserFullName"
"UserName"

7.5.3 Other Read-Only Variables

The following variable is set only as internal Oracle Content Server flags, so it can be retrieved but not set directly.

"SafeDir"

7.6 Setable Variables

Setable variables can be set within script or used within a CGI string. For details about setable variables, see Section 3.8, "Setable Variables."

"ClientControlled"
"coreContentOnly"
"IsJava"
"IsSoap"
"IsXml"
"ScriptDebugTrace"
"ScriptErrorTrace"

7.7 Value Variables

A value variable is evaluated once at the beginning of a service call and that value is used throughout the service call. For details about value variables, see Section 3.9, "Value Variables."