3.2 Configuration Variables

Configuration variables are predefined Idoc Script variables that are generally used as settings in configuration files. These variables can be used within Idoc Script to detect whether a configuration setting is enabled or to return the value of the configuration setting.

  • Configuration variables that pass a Boolean value can be set only to the value TRUE (1) or FALSE (0).

  • Unless otherwise specified, Boolean-type configuration values will default to FALSE (0), and string-type configuration values will default to an empty string.

This section lists the configuration variables 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.

3.2.1 Content Server Configuration Variables

The following configuration files are located in these configuration directories:


"DomainHome/ucm/cs/bin/intradoc.cfg"
"IntradocDir/config/config.cfg"
"IdcHomeDir/components/folders_g/folders_environment.cfg"
"IntradocDir/data/providers/provider_name/provider.hda"

3.2.1.2 IntradocDir/config/config.cfg

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


"AccessListPrivilegesGrantedWhenEmpty"
"AdditionalIndexBuildParams"
"AdditionalSubscriptionCollatedFieldList"
"AllowAllRedirectUrls"
"AllowAlternateMetaFile"
"AllowMatchesInDateCheck"
"AllowPrimaryMetaFile"
"AllowSamePrimaryAlternateExtensions"
"AppletChunkSize"
"AppletChunkThreshold"
"ARCHIVE_COLLECTION"
"ArchiverDoLocks"
"ArchiverTouchMonitorInterval"
"ArchiverTraceLockMaintenance"
"ArchiverTraceLocks"
"AuthorDelete"
"AutoNumberPrefix"
"AutoNumberWidth"
"BinDir"
"CachedResultRowCount"
"ChunkedRequestTrace"
"CollectionLocation"
"ColumnMapFile"
"ConfigDir"
"ConversionCacheExpirationPeriodInDays"
"CookieAuthTimeoutInDays"
"CookieProxyPassword"
"createAlternateMetaFile"
"createPrimaryMetaFile"
"DatabasePreserveCase"
"DatabaseWildcards"
"DatedCacheIntervalDays"
"DateOutputFormat"
"DCMaxFileSize"
"DCTimeOut"
"DCViewFormat"
"Default Accounts"
"DefaultFilterInputFormat"
"DefaultFilterOutputFormat"
"DefaultHtmlConversion"
"DefaultHtmlRefreshTimeoutInSeconds"
"DefaultPasswordEncoding"
"DirectoryLockingLogPath"

"DisableContentProfiles"
"DisableDBLongIntegerField"
"DisableForcedConversions"
"DisableHttpUploadChunking"
"DisableKeepingForcedConversions"
"DisableOptimizedLatestReleaseQuerying"
"DisableSharedCacheChecking"
"DoDocNameOrder"
"DomainControllerName"
"DownloadApplet"
"DtmPort"
"EnableDocumentHighlight"
"EnableEnvironmentPackager"
"EnableExpirationNotifier"
"EnableOptimizedLatestReleaseQuerying"
"EnableRebuildForcesReconversion"
"EnableSchemaPublish"
"ExclusiveCheckout"
"ExpireRevisionOnly"
"ForcedConversionRules"
"ForceDistinctRevLabels"
"ForceDocTypeChoice"
"ForceJdbcSync"
"ForceSecurityGroupChoice"
"FormInheritMetaDataFieldList"
"GetCopyAccess"
"HasExternalUsers"
"HighlightBegin"
"HtmlDataInputFilterLevel"
"HighlightEnd"
"HTMLEditorPath"
"HttpRelativeWebRoot"
"HttpServerAddress"
"IdcAuthExtraRequestParams"
"IdcCommandServerHost"
"IdcHttpHeaderVariables"
"IdcHomeDir"
"IdcLocale"
"IDC_Name"
"IdcServerBindAddress"
"IdcServerSocketQueueDepth"
"IndexableRenditions"
"IndexerAutoWorkInterval"
"IndexerLargeFileSize"
"IndexerRebuildStagingManualCopy"
"IndexerRebuildStagingPath"
"IndexerTouchMonitorInterval"
"IndexerTraceCycleListChanges"
"IndexerTraceLockFileChanges"
"IndexerTraceStartStop"
"InstanceDescription"
"InstanceMenuLabel"
"IntradocRealm"
"IntradocServerHostName"
"IntradocServerPort"
"IsAllowIndexRenditions"
"IsAutoArchiver"
"IsAutoNumber"
"IsAutoQueue"
"IsAutoSearch"
"IsContentRefineryPresent"
"IsDpSubmitErrorFatal"
"IsWebServerPagesOnly"
"IsDynamicConverterEnabled"
"IsFormsPresent"
"rule:IsFragmentOnly"
"IsJdbcLockTrace"
"IsJdbcQueryTrace"
"IsJspServerEnabled"
"IsOverrideFormat"
"IsSavedWfCompanionFile"
"JdbcConnectionString"
"JdbcDriver"
"JdbcPassword"
"JdbcPasswordEncoding"
"JdbcUser"
"JspAdminQuery"
"JspDefaultIndexPage"
"JspEnabledGroups"
"LatestReleasedTimestampTimeout"
"LmDefaultLayout"
"LmDefaultSkin"
"LocaleArchiverDateFormat"
"LogName"
"MacSupportsSignedApplets"
"MailServer"
"MajorRevSeq"
"MaxArchiveErrorsAllowed"
"MaxCollectionSize"
"MaxConversionCacheSizeInMegs"
"MaxDocIndexErrors"
"MaxHitCount"
"MaxIntegerAllowed"
"MaxQueryRows"
"MaxRequestThreadCount"
"MaxResults"
"MaxSavedSearchResults"
"MaxSearchConnections"
"MaxSizeResourceFileCacheMillions"
"MemoFieldSize"
"MinIntegerAllowed"
"MinMemoFieldSize"
"MinorRevSeq"
"MultiUpload"
"NeverTimeoutForcedConversionsTemplateChange"
"NoAutomation"
"noInfoColumn"
"noRevisionsColumn"
"NoSearchConnectionCloseOnDocChange"
"NotificationIntervalInDays"
"NotificationMaximum"
"NotificationQuery"
"NotifyExtras"
"NotifyTime"
"NtlmSecurityEnabled"
"NumAdditionalRenditions"
"NumConnections"
"OdbcDateFormat"
"PrimaryWorkQueueTimeout"
"ProviderDir"
"QueueDir"
"RedirectHostsFilter"
"RequestAuditAdditionalVerboseFieldsList"
"RequestAuditIntervalSeconds1"
"RequestAuditIntervalSeconds2"
"RequestAuditListDepth1"
"RequestAuditListDepth2"
"RequestAuditSubClassificationField"
"SchemaAllowRecursiveFileMove"
"SchemaBuildDigestFile"
"SchemaPublishCheckInterval"
"SchemaPublishInterval"
"SchemaPublishMaximumInterval"
"SchemaPublishMinimumInterval"
"SchemaPublishRenameRetryInitialInterval"
"SchemaPublishRetryInterval"
"SchemaPublishRetryIntervalMax"
"SchemaPublishRenameRetryIterations"
"SchemaVerifyPublishing"
"SchemaWin32RenameDelayInterval"
"SearchCacheCleanerInterval"
"SearchCacheHardLimit"
"SearchCacheMaxItemAgeInMinutes"
"SearchCacheSoftLimit"
"SearchCacheTrace"
"SearchConnectionWaitTimeout"
"SearchDebugLevel"
"SearchDir"
"SearchIndexerEngineName"
"SearchQueryFormat"
"SearchQueryTrace"
"SelfRegisteredAccounts"
"SelfRegisteredRoles"
"ServiceStartupTimeout"
"ShowCreateExternalMenu"
"showDocActions"
"ShowOnlyKnownAccounts"
"ShowRevisionsColumn"
"showSearchResultsCheckoutColumn"
"SkipMozillaMailToWorkaround"
"SmtpPort"
"SocketHostAddressSecurityFilter"
"SocketHostNameSecurityFilter"
"StdPageWidth"
"StrConfineOverflowChars"
"SubjectsDir"
"SubscriptionMethod"
"SubscriptionCollatedFieldList"
"SysAdminAddress"
"SystemDateFormat"
"SystemLocale"

"SystemTimeZone"
"TempDir"
"TimeoutChangedTemplateForcedConversionsInMins"
"TimeoutMismatchedForcedConversionsInMins"
"TimeoutPerOneMegInSec"
"TraceConversionCacheCleanup"
"TraceResourceConflict"
"TraceResourceLoad"
"TraceResourceOverride"
"UniversalSearchAllowFullText"
"UploadApplet"
"UseAccounts"
"UseAdsi"
"UseBellevueLook"
"UseCascadingStyleSheets"
"UseFourDigitYear"
"UseNtlm"
"UserCache"
"UserCacheTimeout"
"UseRedirectedOutput"
"UseRevisionCreateDate"
"UserFilteredSubjects"
"UserPublishCacheDir"
"UseSearchCache"
"UseSSL"
"UseXpedioLook"
"WarnAboutTimeZone"
"WebServerAuthOnly"
"WorkflowDir"
"WorkflowIntervalHours"
"xml"
"XMLEncodingMode"

3.2.1.3 IdcHomeDir/components/folders_g/folders_environment.cfg

The following configuration variables are located in the folders_environment.cfg file in the IdcHomeDir/components/folders_g/ directory. These variables define settings for Content Server folders.


"CollectionDeleteEnabled"
"CollectionHiddenMeta"
"CollectionInhibitUpdateMeta"
"CollectionMeta"
"CollectionMoveEnabled"
"CollectionReadOnlyMarkedFolders"
"CollectionReadOnlyMeta"
"CollectionReleasedOnly"
"CollectionSecurityReadOnly"
"CollectionTrashDeleteDate"
"CollectionTrashDeleteLocation"
"CollectionTrashDeleteOldName"
"CollectionTrashDeleter"
"CollectionWebDAVServer"
"InitialColID"

3.2.1.4 IntradocDir/data/providers/provider_name/provider.hda

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


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

3.2.2 Inbound Refinery Configuration Variables

The following configuration files are located in the Inbound Refinery installation directory (noted by IntradocDir/config/config.cfg).

Configuration variables returning a string that defines a directory or file path related to the Inbound Refinery will return that path relative to the Inbound Refinery installation directory. These paths are generally not recognizable to the Content Server nor usable to the user if passed as information within an HTM page.


"AllowSecondaryConversion"
"AllowSkippedHyperlinktoCauseIncomplete"
"DefaultGraphicTimeout"
"DefaultNativeTimeout"
"DefaultPostscriptTimeout"
"DistillerPath"
"FileEncoding"
"FrameMakerCyclesAllowed"
"FrameMakerTimeout"
"IntradocDir"
"JvmCommandLine"
"MaxNumRecursiveStepDefinitions"
"MSPubexePath"
"OpenOfficeListenerPort"
"OpenOfficeListenerURL"
"PageMakerExePath"
"PostConversionTimeOut"
"PostprocessPDFPath"
"PostscriptPrinterName"
"PowerPointPrintOutput"
"PreconversionPath"
"PreconversionWaitTime"
"PrinterPortPath"
"ProcessExcelUrlHyperlinks"
"ProcessInDesignBookMarks"
"ProcessInDesignHyperlinks"
"ProcessInDesignInternalPDFThumbnail"
"ProcessInDesignLinkUpdate"
"ProcessInDesignPDFCompatibility50"
"ProcessPowerpointHyperlinks"
"ProcessVisioInternalHyperlinks"
"ProcessVisioUrlHyperlinks"
"ProcessWordBookMarks"
"ProcessWordComments"
"ProcessWordEmailLinks"
"ProcessWordFootEndNote"
"ProcessWordHeadings"
"ProcessWordHyperlinks"
"ProcessWordToc"
"ProcessWordUrlHyperlinks"
"SecondaryConversionStepName"
"VaultDir"
"VerboseMode"
"WeblayoutDir"

3.2.3 Link Manager Configuration Variables

The following variables are used to configure the Link Manager application. These variables are set in the IntradocDir/ucm/cs/bin/config.cfg file.


"AllowForceDelete"
"HasSiteStudio"
"LkDisableOnRebuild"
"LkDisableReferenceInfo"
"LkDisallowConversionFormats"
"LkIsSecureSearch"
"LkReExtractOnRebuild"
"LkRefreshBatchSize"
"LkRefreshErrorsPercent"
"LkRefreshErrorsAllowed"
"LkRefreshErrorThreshold"

3.2.4 Pop-Up Calendar Configuration Variables

The following variables are used to configure the Pop-Up Calendar application. These variables are set in the IntradocDir/config/config.cfg file.


"pucDefaultTime"
"pucEnableOnSearch"
"pucHideTimeInDateFields"
"pucUseMonthLocale"
"pucUseWeekdayLocale"
"pucXOffset"
"pucYOffset"
"pucZIndex"