5 Core Functions by Type and Usage

This chapter groups Idoc Script variables and functions that are used for core processing functions such as searching, indexing, and workflow implementation.

These sections describe the different core processing functions by type:

These sections divide the different variables by usage:

5.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.

The following is a list of Idoc Script conditional dynamic variables that are used in core Oracle Content Server functionality. For a list of conditional dynamic variables and details about their use, see Section 3.1, "Conditional Dynamic Variables."


"AllowReview"
"EmptyAccountCheckinAllowed"
"HasUrl"
"isComponentEnabled"
"IsContributor"
"IsCriteriaSubscription"
"IsFilePresent"
"IsFullTextIndexed"
"IsLocalSearchCollectionID"
"IsNotSyncRev"
"IsPromptingForLogin"
"IsWorkflow"
"SingleGroup"
"UseXmlUrl"

5.2 Configuration Variables

Configuration variables are predefined Idoc Script variables that are generally used as settings in configuration files. For a list of configuration variables and details about their use, see Section 3.2, "Configuration Variables."

This section lists the configuration variables used in core Oracle Content Server functions by the configuration file (typically .cfg or .hda) in which they are most commonly located. Your actual application will vary depending on the criteria and selections made during installation.

5.2.1 DomainHome/ucm/product_id/bin/intradoc.cfg

The following configuration variables are located in the DomainHome/ucm/short-product_id/bin/intradoc.cfg file. These variables define directory paths and other global settings for the Oracle Content Server system.


"AllowConcurrentUpdate"
"IdcCommandFile"
"IdcCommandLog"
"IdcCommandUser"

5.2.2 IntradocDir/config/config.cfg

The following configuration variables are located in the IntradocDir/config/config.cfg file. These variables define most of the configuration settings for the Oracle Content Server system.


"AdditionalIndexBuildParams"
"AdditionalSubscriptionCollatedFieldList"
"AllowAllRedirectUrls"
"AllowAlternateMetaFile"
"AllowPrimaryMetaFile"
"AllowSamePrimaryAlternateExtensions"
"AppletChunkSize"
"AppletChunkThreshold"
"AuthorDelete"
"AutoNumberPrefix"
"AutoNumberWidth"
"CachedResultRowCount"
"ColumnMapFile"
"CookieAuthTimeoutInDays"
"CookieProxyPassword"
"DatabasePreserveCase"
"DatabaseWildcards"
"DefaultHtmlRefreshTimeoutInSeconds"
"DefaultPasswordEncoding"
"DisableDBLongIntegerField"
"DisableHttpUploadChunking"
"DoDocNameOrder"
"DomainControllerName"
"EnableDocumentHighlight"
"EnableExpirationNotifier"
"EnableSchemaPublish"
"ExpireRevisionOnly"
"ForceDistinctRevLabels"
"FormInheritMetaDataFieldList"
"GetCopyAccess"
"HasExternalUsers"
"HtmlDataInputFilterLevel"
"IdcAuthExtraRequestParams"
"IdcCommandServerHost"
"IdcHttpHeaderVariables"
"IDC_Name"
"IndexableRenditions"
"IndexerAutoWorkInterval"
"IndexerLargeFileSize"
"IndexerRebuildStagingManualCopy"
"IndexerRebuildStagingPath"
"IndexerTouchMonitorInterval"
"InstanceDescription"
"InstanceMenuLabel"
"IntradocRealm"
"IntradocServerHostName"
"IntradocServerPort"
"IsAllowIndexRenditions"
"IsAutoNumber"
"IsAutoSearch"
"IsWebServerPagesOnly"
"IsFormsPresent"
"IsSavedWfCompanionFile"
"JdbcConnectionString"
"JdbcDriver"
"JdbcPassword"
"JdbcPasswordEncoding"
"JdbcUser"
"LmDefaultLayout"
"LmDefaultSkin"
"MailServer"
"MajorRevSeq"
"MaxCollectionSize"
"MaxDocIndexErrors"
"MaxIntegerAllowed"
"MaxQueryRows"
"MaxRequestThreadCount"
"MaxResults"
"MaxSavedSearchResults"
"MaxSearchConnections"
"MaxSizeResourceFileCacheMillions"
"MinIntegerAllowed"
"MinorRevSeq"
"NoAutomation"
"NoSearchConnectionCloseOnDocChange"
"NotificationIntervalInDays"
"NotificationMaximum"
"NotificationQuery"
"NotifyExtras"
"NotifyTime"
"NtlmSecurityEnabled"
"NumConnections"
"PrimaryWorkQueueTimeout"
"RedirectHostsFilter"
"SchemaAllowRecursiveFileMove"
"SchemaBuildDigestFile"
"SchemaPublishCheckInterval"
"SchemaPublishInterval"
"SchemaPublishMaximumInterval"
"SchemaPublishMinimumInterval"
"SchemaPublishRenameRetryInitialInterval"
"SchemaPublishRetryInterval"
"SchemaPublishRetryIntervalMax"
"SchemaPublishRenameRetryIterations"
"SchemaVerifyPublishing"
"SchemaWin32RenameDelayInterval"
"SearchCacheCleanerInterval"
"SearchCacheHardLimit"
"SearchCacheMaxItemAgeInMinutes"
"SearchCacheSoftLimit"
"SearchConnectionWaitTimeout"
"SearchIndexerEngineName"
"SearchQueryFormat"
"SelfRegisteredAccounts"
"SelfRegisteredRoles"
"ServiceStartupTimeout"
"ShowCreateExternalMenu"
"SkipMozillaMailToWorkaround"
"SmtpPort"
"SocketHostAddressSecurityFilter"
"SocketHostNameSecurityFilter"
"SubscriptionMethod"
"SubscriptionCollatedFieldList"
"TimeoutPerOneMegInSec"
"UniversalSearchAllowFullText"
"UseAccounts"
"UseAdsi"
"UseNtlm"
"UseRevisionCreateDate"
"UserFilteredSubjects"
"UseSearchCache"
"UseSSL"
"WebServerAuthOnly"
"WorkflowIntervalHours"
"XMLEncodingMode"

5.2.3 DomainDir/ucm/short_product_id/data/providers/provider_name/provider.hda

The following configuration variables are located in the provider.hda file in the DomainDir/ucm/short_product_id/data/providers/provider_name/ directory. These variables define settings for Oracle Content Server providers.


"IsPrimaryUserBase"
"LdapAdminDN"
"LdapAdminPassword"
"LdapPort"
"LdapServer"
"LdapSuffix"
"NumConnections"
"Priority"
"ProviderClass"
"ProviderConfig"
"ProviderConnection"
"ProviderType"
"SourcePath"
"UseNetscape"
"UseSecureLdap"

5.3 Environment Variables

Web server variables are the CGI environment variables that are set when the server executes the gateway program. For a list of conditional dynamic variables and details about their use, see "Environment Variables".

The following is a list of web server variables used in core Oracle Content Server functionality:


"CONTENT_LENGTH"
"GATEWAY_INTERFACE"
"HTTP_ACCEPT"
"HTTP_ACCEPT_ENCODING"
"HTTP_ACCEPT_LANGUAGE"
"HTTP_COOKIE"
"HTTP_HOST"
"HTTP_INTERNETUSER"
"HTTP_REFERER"
"HTTP_USER_AGENT"
"PATH_INFO"
"QUERY_STRING"
"REMOTE_ADDR"
"REMOTE_HOST"
"REQUEST_METHOD"
"SCRIPT_NAME"
"SERVER_NAME"
"SERVER_PORT"
"SERVER_PROTOCOL"
"SERVER_SOFTWARE"

5.4 Global Functions

Idoc Script has many built-in global functions. Functions perform actions, including string comparison and manipulation routines, date formatting, and ResultSet manipulation. Some functions also return results, such as the results of calculations or comparisons. For a list of global functions and details about their use, see Section 3.5, "Global Functions."

The following is a list of Idoc Script global functions:


"clearSchemaData"
"computeRenditionUrl"
"docUrlAllowDisclosure"
"encodeHtml"
"formatDateDisplay"
"formatTimeOnlyDisplay"
"getFieldConfigValue"
"getFieldViewDisplayValue"
"getParentValue"
"getViewValue"
"getViewValueResultSet"
"hasAppRights"
"indexerSetCollectionValue"
"isLayoutEnabled"
"jsFilename"
"lmGetLayout"
"lmGetSkin"
"loadCollectionInfo"
"loadSchemaData"
"regexMatches"
"regexReplaceAll"
"regexReplaceFirst"
"stdSecurityCheck"

5.5 Setable Variables

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


"getCookie"
"setCookie"

5.5.1 Workflows

Idoc Script includes predefined settable functions and variables that are used specifically for workflows.

For a detailed description of how workflows are implemented in the Oracle Content Server system, see the Oracle Fusion Middleware Application Administrator's Guide for Content Server. The following is a list of workflow functions:


"wfAddActionHistoryEvent"
"wfAddUser"
"wfComputeStepUserList"
"wfCurrentGet"
"wfCurrentSet"
"wfCurrentStep"
"wfDisplayCondition"
"wfExit"
"wfGet"
"wfIsFinishedDocConversion"
"wfIsNotifyingUsers"
"wfIsReleasable"
"wfLoadDesign"
"wfNotify"
"wfSet"
"wfSetIsNotifyingUsers"
"wfUpdateMetaData"

Workflow variables are used to set values related to workflows. The following is a list of workflow variables:


"dWfName"
"dWfStepName"
"entryCount"
"lastEntryTs"
"wfAction"
"wfAdditionalExitCondition"
"wfGetStepTypeLabel"
"wfJumpEntryNotifyOff"
"wfJumpMessage"
"wfJumpName"
"wfJumpReturnStep"
"wfJumpTargetStep"
"wfMailSubject"
"wfMessage"
"wfParentList"
"wfReleaseDocument"
"WfStart"

5.6 Value Variables

A value variable is evaluated once at the beginning of a service call and that value is used throughout the service call. The variable is then reevaluated on each new service call. Certain value variables can be set at the end of a service call or during a service call. For a list of value variables and details about their use, see Section 3.9, "Value Variables."

The following is a list of Idoc Script value variables used in core Oracle Content Server functionality:


"DocTypeSelected"
"DocUrl"
"fileUrl"
"FIRSTREV"
"HasOriginal"
"IsEditRev"
"IsFailedIndex"
"IsNotLatestRev"
"isZoneSearchField"
"NoMatches"
"OneMatch"
"StatusCode"
"StatusMessage"
"UseHtmlOrTextHighlightInfo"