10 Feature and Product Variables and Functions

This chapter lists Idoc Script variables and functions in alphabetical order, and provides details about each item.


AccesslistPrivilegesGrantedWhenEmpty

Specifies that empty Access Control Lists (ACLs) in Oracle WebCenter Content behave the same as empty lists in Oracle WebCenter Content: Records.

  • When set to FALSE, empty ACLs in Records behave as if no ACL is defined.

  • When set to TRUE, if no ACL is defined in standard Oracle WebCenter Content then only users with Admin permission are able to access content.

The default is FALSE.

Restart Oracle WebCenter Content: Records for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

AccesslistPrivilegesGrantedWhenEmpty=false

AllowForceDelete

Used to delete content items that are referenced or used by other content items.

The default setting is AllowForceDelete=FALSE. This configures the Oracle WebCenter Content Server instance to refuse a request to delete a content item that is referenced as a link.

If set to AllowForceDelete=true, allows Oracle WebCenter Content Server to delete a content item that is referenced as a link. Deleting a content item that is referenced by other content items invalidates the links. If the value is not set to true, a request to delete a referenced content item will fail.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

AllowForceDelete=TRUE

See Also


AllowRetentionPeriodWithoutCutoff

Specifies retention periods for triggers for non-record content items.

  • If set to TRUE, retention periods for triggers for non-record content items are enabled.

  • If set to FALSE, retention periods are disabled.

The default is TRUE.

Restart WebCenter Content for this variable to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

AllowRetentionPeriodWithoutCutoff=false

AllowSecondaryConversion

Defines if the Oracle WebCenter Content: Inbound Refinery system will use a backup conversion step if the native conversion step fails.

  • When set to TRUE, the backup conversion step will be used upon conversion failure.

  • When set to FALSE, no backup conversion step will be used upon conversion failure.

The Default is TRUE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, General tab, Allow secondary conversion step

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

AllowSecondaryConversion=false

See Also


AllowSkippedHyperlinktoCauseIncomplete

Marks the conversion as incomplete when a link cannot be converted to PDF.

  • When set to TRUE, the conversion is marked as incomplete when a link cannot be converted.

  • When set to FALSE, hyperlinks that cannot be converted are skipped, and the conversion is marked as converted.

The default is TRUE.

Type and Usage

Location

IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

As a configuration entry:

AllowSkippedHyperlinktoCauseIncomplete=false

CollectionDeleteEnabled

Specifies if the Delete icon is displayed so users can delete contribution folders and content items.

  • When set to TRUE, displays the Delete icon so users can delete contribution folders and content items from the Exploring page.

  • When set to FALSE, hides the Delete icon.

  • The default value is TRUE if the variable is not set explicitly by the user.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

Example

Used as a configuration entry:

CollectionDeleteEnabled=true

CollectionHiddenMeta

Enables users to specify if a folder or content item is hidden or visible.

  • This setting adds Hide/Unhide icons to the Exploring page.

  • This setting adds a Show hidden when browsing check box to the Folder Configuration page.

  • This is set automatically by the contribution folders installer program according to options specified at install time.

Type and Usage

Location

IntradocDir/data/components/Folders_g/install.cfg

See Also

This feature can be enabled manually. For details, see Oracle WebCenter Content Application Administrator's Guide for Content Server.


CollectionInfoEnabled

Specifies if the Folder Information and Content Information options on an Action menu are displayed or hidden.

  • When set to TRUE, displays the Folder Information and Content Information options on an Action menu so users can choose to view folder and content item information.

  • When set to FALSE, hides the Folder Information and Content Information options on an Action menu.

  • The default value is TRUE if the variable is not set explicitly by the user.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

Example

Used as a configuration entry:

CollectionInfoEnabled=false

CollectionInhibitUpdateMeta

Defines an inhibit field for the metadata propagation function. This variable enables contributors to copy metadata values from a contribution folder to its subfolders and content items.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

See Also

This feature can be enabled manually. For details, see Oracle WebCenter Content Application Administrator's Guide for Content Server.


CollectionLinkEnabled

Specifies if the Create Shortcut option on an Action menu is displayed or hidden.

  • When set to TRUE, displays the Create Shortcut option on an Action menu so users can choose to create a shortcut to the contribution folder.

  • When set to FALSE, hides the Create Shortcut option on an Action menu.

  • The default value is TRUE if the variable is not set explicitly by the user.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

Example

Used as a configuration entry:

CollectionLinkEnabled=false

CollectionMeta

Specifies the metadata field that is used to store the unique Collection ID for each contribution folder.

  • If this setting is not specified in the configuration file, the default value is xCollectionID.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

See Also

This feature can be enabled manually. For details, see Oracle WebCenter Content Application Administrator's Guide for Content Server.


CollectionMoveEnabled

Specifies if the Move icon is displayed on the Exploring pages.

  • When set to TRUE, displays the Move icon so users can move contribution folders and content items to other contribution folders.

  • When set to FALSE, hides the Move icon.

  • The default value is TRUE if the variable is not set explicitly by the user.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

Example

Used as a configuration entry:

CollectionMoveEnabled=true

CollectionReadOnlyMarkedFolders

Specifies if system-level contribution folders (such as contribution server folders and Trash) can be modified (that is, set to Read Only status).

  • When set to TRUE, prevents modification of system-level contribution folders.

  • When set to FALSE, enables modifications.

  • This variable is set to TRUE by default.

  • If this variable is set to FALSE, you should assign an appropriate security group to the system-level contribution folders so only authorized personnel can change them. System-level contribution folders should be changed only if there is a particular reason to do so.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

Example

Used as a configuration entry:

CollectionReadOnlyMarkedFolders=true

CollectionReadOnlyMeta

Enables users to specify if a contribution folder and its contents are read-only.

  • Read-only is subject to the rules of the operating environment where the instance is run.

  • This adds Read-only/Editable icons to the Exploring pages.

  • This setting applies only to the current contribution folder level. A subfolder does not inherit the status from the parent.

  • This variable is set automatically by the Folders installation program according to options specified at install time.

Type and Usage

Location

IntradocDir/data/components/Folders_g/install.cfg

See Also

This feature can be enabled manually. For details, see Oracle WebCenter Content Application Administrator's Guide for Content Server.


CollectionReleasedOnly

Specifies if a revised document is visible to the author and users with Read permission to the content item.

  • If set to FALSE, then allows the author and all users with Read permission to the content item to see the latest version. Content item visibility is based on the item version, not the release state.

    The author and users with Read access can view revised items before and after they are converted, indexed, and released. Even if the revised content item fails conversion or indexing, it is still visible to the author and users with Read access. If the release date of the new revision is set to a future date, the revised content item is also visible to the author and all other users with Read access.

  • If set to TRUE, and if the item has not released, and the user accessing the item is not the author, then no part of the content item will be visible. Content item visibility is based on the release state, not the item version.

    When a new revision of a content item is checked into a contribution folder, the new revision is only visible to the author. It does not become visible to other users with Read access to that content item until it is converted, indexed, and released. Therefore, until the content item is released, nothing is displayed for non-authoring users. If the release date of the new revision is set to a future date, the revised content item is not visible to other users until that point in time.

  • This variable is set to FALSE by default.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

Example

Used as a configuration entry:

CollectionReleasedOnly=false

CollectionSecurityReadOnly

Specifies if users can see content items for which they have only Read permission.

  • When set to TRUE, allows users to see content items for which they have only Read permissions.

  • When set to FALSE, requires that users have at least Write permission to see a content item.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

Example

Used as a configuration entry:

CollectionSecurityReadOnly=false

CollectionTrashDeleteDate

Defines a date metadata field for the Trash function.

  • When set, this defines a date metadata field for the Trash function, which enables the deletion date and time to be recorded as metadata for items moved to the Trash folder.

  • This variable is set automatically by the Folders installation program if the Trash Bin function is enabled at install time.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

See Also

This feature can be enabled manually. For details, see Oracle WebCenter Content Application Administrator's Guide for Content Server.


CollectionTrashDeleteLocation

Defines an integer metadata field designating the parent contribution folder for the Trash function.

  • When set, this enables the original parent contribution folder to be recorded as metadata for items moved to the Trash folder.

  • If set, users can restore deleted items from the Trash folder.

  • If set, the deletion date and time are displayed in the Trash folder.

  • This variable is set automatically by the Folders installation program if the Trash Bin function is enabled at install time.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

See Also

This feature can be enabled manually. For details, see Oracle WebCenter Content Application Administrator's Guide for Content Server.


CollectionTrashDeleteOldName

Defines a metadata field for the Trash function to track file names of deletions.

  • When set, files that are renamed due to a naming conflict in the Trash folder can be restored with their original file names.

  • This defines a file name metadata field for the Trash function. This enables the original file name to be recorded as metadata for items that are moved to the Trash folder.

  • This variable is set automatically by the Folders installation program if the Trash Bin function is enabled at install time.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

See Also

This feature can be enabled manually. For details, see Oracle WebCenter Content Application Administrator's Guide for Content Server.


CollectionTrashDeleter

Defines a metadata field for the Trash function to track user deletions.

  • When set, this defines a metadata field for the Trash function which records the user's login information as metadata for items that are moved to the Trash folder.

  • If set, users can choose to view only the items they have moved to the Trash folder or view all items that everyone has moved to the Trash folder.

  • This variable is set automatically by the Folders installation program if the Trash Bin function is enabled at install time.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

See Also

This feature can be enabled manually. For details, see Oracle WebCenter Content Application Administrator's Guide for Content Server.


CollectionWebDAVServer

Enables switching views in Windows Explorer.

  • If set to a WebDAV URL, this enables users to switch the view from an Oracle WebCenter Content Serverpage to a WebDAV contribution folder in Windows Explorer.

  • WebDAV functionality on the Oracle WebCenter Content Server instance must be installed to use this function.

  • In Microsoft Internet Explorer 5.0 or later, this adds a web contribution folder icon to the virtual Exploring contribution folder (this icon is not displayed in any other browser).

  • This variable is set automatically by the Folders installation program if the WebDAV function is enabled at install time.

  • If the WebDAV function is enabled by setting the environment variable, instead of being set by the Folders installation program, then the setting must be to the WebDAV root of your Oracle WebCenter Content Server instance.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

Example

CollectionWebDAVServer=http://domain/_dav/cs/idcplg/webdav

ConversionCacheExpirationPeriodInDays

Defines the minimum number of days that Dynamic Converter content will remain cached.

  • Content converted by Dynamic Converter will not be deleted from the cache before it is this many days old (based on last access date). Content may stay in the cache longer, depending on when the next cleanup scan is run. See DatedCacheIntervalDays.

  • This setting applies only to files that are no longer in the Oracle WebCenter Content Server system or were not generated by a forced or up front conversion. For information on cache cleanup rules, see MaxConversionCacheSizeInMegs.

  • Default is 7.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

ConversionCacheExpirationPeriodInDays=14

See Also


DatedCacheIntervalDays

Defines the number of days between scans for cached Dynamic Converter content to delete.

  • The Oracle WebCenter Content Server system scans at this interval to find and delete old cached content.

  • Default is 7.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DatedCacheIntervalDays=30

See Also


DCMaxFileSize

Defines the maximum size in bytes of files that Dynamic Converter will process.

  • If a source file is larger than the specified value, the conversion will not occur.

  • Default is 20000000 (20 megabytes).

  • Used in Dynamic Converter version 5.0 and higher.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DCMaxFileSize=10000000

dcShowExportLink

This function verifies if the Dynamic Converter has been configured to convert a content item. The returned value is based on the value for dFormat for the item.

This function is typically used on Search Result pages to conditionally display a Dynamic Converter link.

Type and Usage

Output

  • Returns TRUE if the Dynamic Converter is configured to convert the content item.

  • Returns FALSE if the Dynamic Converter is not configured.

Example

<$QueryText = "dDocTitle <substring> `test`"$>
<$executeService("GET_SEARCH_RESULTS")$>
<$loop SearchResults$>
    <$if dcShowExportLink()$>
        <a href="<$HttpCgiPath$>?IdcService=
        GET_DYNAMIC_CONVERSION&dID=<$dID$>">
        HTML Conversion of <$dDocTitle$></a>
    <$endif$>
<$endloop$>

DCTimeOut

Sets the timeout value in minutes for the Dynamic Converter conversion process.

  • Defines the number of minutes to wait for the dynamic conversion of a document into HTML.

  • Default is 3 minutes.

  • Used in Dynamic Converter version 5.0 and higher.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DCTimeOut=5

DCViewFormat

Defines which rendition of the source file will be converted by Dynamic Converter.

  • When set to native, the native file is converted.

  • When set to webviewable, the web-viewable file is converted.

  • When set to alternate, the alternate file is converted.

  • Default is native.

  • Used in Dynamic Converter version 5.0 and higher.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DCViewFormat=webviewable

DebugStdConversion

Configuration setting that overrides the conversion/step definitions published by the Oracle WebCenter Content Server system.

Type and Usage

Parameters

This variable takes one argument, the path to the new definitions.

Location

IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

DebugStdConversion=/temp/idcconversions

DefaultFilterInputFormat

Defines the default input character set for conversion filters, such as Dynamic Converter or the Text Indexer Filter component.

  • Conversion products use the character encoding of the system to determine the encoding of the input to the conversion filter. This should be sufficient in most cases; however, there may be cases when you want to override this value.

  • For a complete list of encoding values, see the lcIsoEncoding values in the std_encoding.htm file, which is located in the IdcHomeDir/resources directory.

  • Default is Cp1252.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry for Japanese text:

DefaultFilterInputFormat=shift_jis

Used as a configuration entry for Korean text:

DefaultFilterInputFormat=euc-kr

See Also


DefaultFilterOutputFormat

Defines the default output character set for conversion filters, such as Dynamic Converter or the Text Indexer Filter component.

  • Conversion products use the character encoding of the system to determine the encoding of the output to the conversion filter. This should be sufficient in most cases; however, there may be cases when you want to override this value.

  • For a complete list of encoding values, see the lcIsoEncoding values in the std_encoding.htm file, which is located in the IdcHomeDir/resources directory.

  • Default is Cp1252.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry for Japanese text:

DefaultFilterOutputFormat=shift_jis

Used as a configuration entry for Korean text:

DefaultFilterOutputFormat=euc-kr

See Also


DefaultGraphicTimeout

Defines the default thumbnail timeout.

  • Returns the thumbnail timeout values.

  • This variable must be followed by one of these flags:

    Flag Description
    #factor This value is multiplied by the file size to determine the amount of time allowed for thumbnail conversion. (The resulting time is limited by the #max and #min flags.) The default value is 3. Increase this value for busy or slow systems.
    #max Specifies the maximum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for the thumbnail conversion process to complete. The default time is 60 seconds.
    #min Specifies the minimum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for the thumbnail conversion process to complete. The default time is 5 seconds.

Type and Usage

Location

  • Shared Inbound Refinery Configuration screen, Timeout Values tab, Default Timeout for Graphics

  • IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

DefaultGraphicTimeout#factor=3

DefaultHtmlConversion

Defines the default template for Dynamic Converter conversions.

  • This value must be the Content ID of a checked-in template file to specify as the default.

  • There is no default value.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DefaultHtmlConversion=PLAIN

DefaultNativeTimeout

Defines the default native file timeout.

  • Returns the native file timeout values.

  • This variable must be followed by one of these flags:

    Flag Description
    #factor This value is multiplied by the file size to determine the amount of time allowed for native-to-PostScript conversion. (The resulting time is limited by the #max and #min flags.) The default value is 3. Increase this value for busy or slow systems.
    #max Specifies the maximum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for the native-to-PostScript conversion process to complete. The default time is 10 seconds.
    #min Specifies the minimum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for the native-to-PostScript conversion process to complete. The default time is 2 seconds.

Type and Usage

Location

  • Shared Inbound Refinery Configuration screen, Timeout Values tab, Default Native to Postscript Timeout

  • IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

DefaultNativeTimeout#factor=3

DefaultPostscriptTimeout

Defines the default PostScript timeout.

  • Returns the default PostScript timeout values.

  • This variable must be followed by one of these flags:

    Flag Description
    #factor This value is multiplied by the file size to determine the amount of time allowed for PostScript-to-PDF conversion. (The resulting time is limited by the #max and #min flags.) The default value is 4. Increase this value for busy or slow systems.
    #max Specifies the maximum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for the PostScript-to-PDF conversion process to complete. The default time is 2 seconds.
    #min Specifies the minimum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for the PostScript-to-PDF conversion process to complete (native or PostScript). The default time is 20 seconds.

Type and Usage

Location

  • Shared Inbound Refinery Configuration screen, Timeout Values tab, Default Postscript to PDF Timeout

  • IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

DefaultPostscriptTimeout#factor=4

DisableForcedConversions

Defines whether forced and up front conversions in Dynamic Converter are disabled.

  • When set to TRUE, files will only be converted by Dynamic Converter when a user views the dynamically converted rendition. Conversions at checkin (forced and up front) will not occur.

  • This setting applies to any new files checked in after the setting is set to TRUE. Any existing forced and up front conversions will still be used, unless the DisableKeepingForcedConversions setting is enabled.

  • This setting might be useful in the following situations:

    • Server space for caching or processing capacity for conversion is limited.

    • Most files are rarely viewed as web pages, so a relatively small number of files must be converted dynamically.

    • The delay time for on-the-fly conversions is acceptable.

  • Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DisableForcedConversions=true

See Also


DisableKeepingForcedConversions

Defines whether Dynamic Converter treats converted files as forced conversions for updating purposes.

  • When set to TRUE, files that were converted by forced or up front conversion are not considered forced conversions by Dynamic Converter. This means that even if Dynamic Converter would normally use the existing conversion rather than reconverting the file, the existing conversion will not be recognized as a forced conversion and the file will be reconverted.

  • Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DisableKeepingForcedConversions=true

See Also


DisableOptimizedLatestReleaseQuerying

Defines whether cached timestamps or Oracle WebCenter Content Server database information is used by Dynamic Converter to determine which files must be reconverted.

  • When set to TRUE, Dynamic Converter queries the Oracle WebCenter Content Server database rather than the cached timestamps to determine which files must be reconverted.

  • Enabling this setting reverts to pre-6.2 Dynamic Converter behavior. This setting can be used if you need to troubleshoot a related issue.

  • Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DisableOptimizedLatestReleaseQuerying=true

DistillerPath

Sets the path to the executable used by PDF Converter to convert files to PDF.

  • Returns the path as a string.

  • If Adobe Acrobat Distiller is not detected during installation of PDF Converter, the default is the path to the Jaws PDF Library.

  • If Adobe Acrobat Distiller is detected during installation of PDF Converter, the default is the path to the Distiller executable.

Type and Usage

Location

  • Shared Inbound Refinery Configuration screen, Paths tab, Adobe Distiller Executable File Path

  • IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

DistillerPath=C:/Program Files/IdcRefinery/shared/jaws_ps/ps2pdf.exe

dodSkipCatFolderRequirement

Specifies that an item is allowed to be checked in without specifying a category or contribution folder for the checkin. If a DoD configuration is in use, this will cause non-conformance with DoD regulations.

  • When set to TRUE, items must be checked in with a category or contribution folder specified.

  • When set to FALSE, items may be checked in without specifying a category or contribution folder.

The default is TRUE.

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

dodSkipCatFolderRequirement=false

DtmPort

Defines the port number on which the DtmServer (required for HTML Preview) listens to connections from Content Publisher clients.

Default is 4441.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DtmPort=4442

DynamicConverterHtmlFlavor

Defines the HTML flavor used by Dynamic Converter.

  • Possible settings are:

    • Internet Explorer 4.0

    • Netscape 4.0

    • HTML 3.0

    • HTML 4.0

  • Default is null.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DynamicConverterHtmlFlavor=HTML 4.0

EnableRebuildForcesReconversion

Defines whether up front and forced Dynamic Converter conversions are reevaluated during a rebuild of the search index.

  • When set to TRUE, content items being indexed during an index rebuild will be reevaluated for conversion by Dynamic Converter based on the conversion rules for forced and up front conversions.

  • This setting can be used to dynamically convert files during an index rebuild after you have created a new conversion rule.

  • Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

EnableRebuildForcesReconversion=true

See Also


ForcedConversionRules

Defines the Dynamic Converter rules that will apply forced conversions upon file checkin.

  • This is a comma-delimited list.

  • If a content item matches any of the specified conversion rules upon checkin, the file will be converted according to that rule. Each file can be converted into multiple renditions.

  • There is no default.

    Note:

    The forced conversion process does not apply the same Dynamic Converter template twice. For example, if you set ForcedConversionRules=RuleA,RuleB, but RuleA and RuleB specify the same template with a different layout, the conversion according to RuleB will not occur. (Best practice in this case would be to merge the layouts and use Idoc Script to dynamically select the appropriate layout elements.)

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

ForcedConversionRules=Rule1,Rule2,Rule3

See Also


FrameMakerCyclesAllowed

The maximum number of 30-second cycles that the Oracle WebCenter Content: Inbound Refinery system allows before FrameMaker is considered to be not responding.

The Inbound Refinery system watches the consfile.txt file for FrameMaker activity.

Default is 1.

Type and Usage

Location

IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

FrameMakerCyclesAllowed=1

FrameMakerTimeout

Defines the FrameMaker conversion timeout.

Returns the FrameMaker timeout values.

This variable must be followed by one of these flags:

Flag Description
#factor This value is multiplied by the file size to determine the amount of time allowed for FrameMaker conversion. (The resulting time is limited by the #max and #min flags.) The default value is 1. Increase this value for busy or slow systems.
#max Specifies the maximum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for the FrameMaker conversion process to complete. The default time is 10 seconds.
#min Specifies the minimum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for the FrameMaker conversion process to complete. The default time is 1 second.

Type and Usage

Location

  • Shared Inbound Refinery Configuration screen, Timeout Values tab, FrameMaker to PostScript Timeout

  • IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

FrameMakerTimeout#factor=2

HasSiteStudio

Used with the Link Manager functionality.

If Site Studio is installed, this variable enables the Site Studio-specific link patterns for parsing friendly URLs for the pattern engine. If set to TRUE, this variable enables the Site Studio-specific link patterns.

The default value is FALSE, which disables the Site Studio-specific link patterns.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

HasSiteStudio=TRUE

See Also


HideVitalReview

This variable hides the Subject to Review related fields on Records Search and Checkin pages.

  • If set to TRUE, Subject to Review fields are hidden.

  • If set to FALSE, Subject to Review fields are revealed.

The default is TRUE.

Restart WebCenter Content for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

HideVitalReview=false

HighlightBegin

Sets the opening HTML tag of the text highlighting style for files converted by Dynamic Converter.

Default is <strong>.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

HighlightBegin=<b><font color=blue>

See Also


HighlightEnd

Sets the closing HTML tag of the text highlighting style for files converted by Dynamic Converter.

Default is </strong>.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

HighlightEnd=</font></b>

See Also


IdcNativeDir

Defines the path to the resource data subdirectory of the runtime media home for the Oracle WebCenter Content Server system.

For information on local copies and load balancing, see Oracle Fusion Middleware Enterprise Deployment Guide for Oracle WebCenter Content.

Type and Usage

Location

  • IdcNativeDir/resources

Example

Used as a configuration entry:

$IdcNativeDir=/ucm/cs/resources/

IdcResourcesDir

Defines the path to the resource data subdirectory of the runtime media home for Oracle WebCenter Content.

For information on local copies and load balancing, see Oracle Fusion Middleware Enterprise Deployment Guide for Oracle WebCenter Content.

Type and Usage

Location

  • IdcHomeDir/resources

Example

Used as a configuration entry:

$IdcHomeDir=/ucm/resources/

incDynamicConversionByRule

Returns the results of converting the LatestReleased revision of a document using the template and layout associated with a particular Dynamic Converter conversion rule.

Fragments created through forced conversions can be referenced directly using this function.

Type and Usage

Parameters

Takes two parameters:

  • The first parameter is the Content ID of a document.

  • The second parameter is the name of a conversion rule.

Output

Retrieves the specified document converted according to the template and layout defined for the specified conversion rule.

Example

Retrieves the converted rendition of the content item with a Content ID of PhoneList, converted according to conversion rule RuleA:

<$incDynamicConversionByRule("PhoneList","RuleA")$>

See Also


InitialColID

Defines the counter that initializes the first collection ID.

This defines the initial contribution folder identifier for the server (in millions).

This variable is set automatically by the Folders installation program if the WebDAV function is enabled at install.

Default is 0.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

Example

InitialColID=0

IsAutoQueue

Enables the processing of content items after conversion by the Oracle WebCenter Content: Inbound Refinery system.

If set to TRUE, the Oracle WebCenter Content Server system will process content items after conversion by the Inbound Refinery system.

If set to FALSE, the Oracle WebCenter Content Server system will not process content items after conversion by the Inbound Refinery system.

The NoAutomation setting overrides this setting.

Default is TRUE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IsAutoQueue=false

See Also


IsContentRefineryPresent

Specifies if the Oracle WebCenter Content: Inbound Refinery system is installed.

This value is set to FALSE during initial Oracle WebCenter Content Server installation.

This value is set to TRUE during Inbound Refinery installation.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IsContentRefineryPresent=true

IsDynamicConverterEnabled

Enables Dynamic Converter.

This value is set to FALSE during initial Oracle WebCenter Content Server installation.

This value is set to TRUE during Dynamic Converter installation.

Default is FALSE.

Type and Usage

Location

  • System Properties, Options tab, Enable Dynamic Converter

  • Admin Server, General Configuration, Enable Dynamic Converter

  • IntradocDir/config/config.cfg

Example

As a configuration setting, enables Dynamic Converter functionality:

IsDynamicConverterEnabled=true

As script, used to evaluate whether dynamic converter functionality is enabled:

<$if IsDynamicConverterEnabled and isTrue(IsDynamicConverterEnabled)$>
    <tr>
      <td align="center" width="75">
        <a href="<$HttpCgiPath$>?IdcService=GET_TEMPLATE_CONVERSIONS">
          <img src="<$HttpImagesRoot$><$admin_conversion_image$>" border="0"
        width="<$adminImageWidth$>" height="<$adminImageHeight$>"></a>
      </td>
      <td width="10">&nbsp;
      </td>
      <td width="245"><span class=largeTableEntry>
        <a href="<$HttpCgiPath$>?IdcService=GET_TEMPLATE_CONVERSIONS">
        <$lc("wwTemplateConversions")$></span></a>
      </td>
    </tr>
<$endif$>

IsFailedConversion

Checks if the Oracle WebCenter Content: Inbound Refinery system has failed to convert the content item.

Type and Usage

Output

  • Returns TRUE if the conversion process failed.

  • Returns FALSE if no conversion failure was detected.

Example

Displays text if the conversion process was not complete:

<$if IsFailedConversion$>
    <p><font face="arial" size="2">
    The Refinery was unable to complete the conversion process.</p>
<$endif$>

LatestReleasedTimestampTimeout

Defines the minimum interval in milliseconds at which the timestamp of a converted content item will be checked.

For a particular cached web-viewable file, Dynamic Converter will consult the timestamp again only after the time specified by this setting has passed.

If the timestamp of a cached content item has changed, Dynamic Converter reconverts the file.

Default is 1500 milliseconds (1.5 seconds).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

LatestReleasedTimestampTimeout=60000

LkDisableOnRebuild

Used with the Link Manager functionality.

This variable controls link extraction during the indexing rebuild cycle.

If set to TRUE, this variable prevents Link Manager from extracting links during the index rebuild cycle. If set to FALSE, Link Manager extracts links during the indexing rebuild cycle.

The default is FALSE.

Because Link Manager does all of its work during the indexing cycle, it will increase the amount of time required to index documents and to rebuild collections. However, the time taken may not be noticeable because most of the time is spent indexing the document into the collection. The amount of time required depends on the type and size of the documents involved. That is, if the file needs to be converted, this requires more time than text-based (HTML) files.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

LkDisableOnRebuild=TRUE

See Also


LkDisableReferenceInfo

Used with the Link Manager functionality.

This variable enables or disables the Resources section on the Content Information page. If set to TRUE, it configures the Oracle WebCenter Content Server system to suppress the References section. Link Manager then does not compute the link references for presentation.

If set to FALSE, the Oracle WebCenter Content Server system displays the Show and Hide toggle switches on the Content Information page. By clicking on the toggle switch, link references are displayed or concealed.

The default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

LkDisableReferenceInfo=TRUE

See Also


LkDisallowConversionFormats

Used with the Link Manager functionality.

This variable provides a list of file formats that Link Manager will not covert before being processed for link extraction. By default, this is empty.

There are some file formats (such as Word) that must be converted by HtmlExport before links can be extracted. However, links in text-based file formats (HTML) can be extracted by Link Manager without requiring conversion by HtmlExport.

For example, you may have PHP files (or files in some other custom format) that are actually text-based. For such files, conversion by HtmlExport may not be necessary before Link Manager processes them for link extraction. Such formats can be listed in this configuration variable.

Type and Usage

Parameters

The only parameter(s) are the formats.

Location

IntradocDir/config/config.cfg

Examples

In the following example, specifying the full MIME type format limits the variations of the listed types that are excluded. For example, listing application/msword will not exclude application/vnd.msword or other variations. In this case, you must include each specific MIME type variation in the list that you want to exclude.

LkDisallowConversionFormats=application/msword,audio/wav,video/avi

In the following example, all variations of each MIME type in the list are excluded. Using the shortened format of the MIME type is more advantageous in that it allows greater flexibility.

LkDisallowConversionFormats=msword,wav,avi

Important:

Link Manager does not use HtmlExport to convert files that contain any of the following strings in the file format: hcs, htm, image, text, xml, jsp, and asp. These files are handled by Link Manager without need for conversion. To check the current file formats and extension mappings of your system, use the File Formats window in the Configuration Manager

See Also


LkIsSecureSearch

Used with the Link Manager functionality.

This variable is used to manage security restriction checks for non-admin users during a managed link search.

If set to TRUE, this configures Link Manager to perform a security check on non-admin users while implementing a managed link search. This is the default setting.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

LkIsSecureSearch=TRUE

See Also


LkReExtractOnRebuild

Used with the Link Manager functionality.

This variable controls link extraction from previously indexed documents during a rebuild. If set to TRUE, it configures Link Manager to extract links from documents as they are indexed into the system during a rebuild. This is the default setting.

If set to FALSE, this prevents Link Manager from extracting links from documents as they are indexed into the system during a rebuild.

Because Link Manager does all of its work during the indexing cycle, it will increase the amount of time required to index documents and to rebuild collections. However, the time taken may not be noticeable since most of the time is spent indexing the document into the collection. Although, the amount of time required does depend on the type and size of the documents involved. That is, if the file needs to be converted, this requires more time than text-based (HTML) files.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

LkReExtractOnRebuild=FALSE

See Also


LkRefreshBatchSize

Used to control the number of links submitted to Site Studio during a refresh process. By default, the batch size value is set to 100.

Depending on the value, this configuration variable can make the refresh processes more (or less) receptive to an abort request. The calculation for LkRefreshErrorsAllowed is completed after, not during, each batch process. Therefore, the lower the value for LkRefreshBatchSize, the more likely it is that the refresh activity will promptly terminate because the number of allowed errors is more quickly exceeded.

If you are using Site Studio, LkRefreshBatchSize enables you to have better control over the refresh abort option than using the combined LkRefreshErrorPercent and LkRefreshErrorThreshold settings. For example, if you set the percent value to 5 and the threshold value to 20, you would expect the refresh activity to abort after the first error. However, Link Manager might actually process more than one error before aborting.

The reason for this is that during refresh activities, all the links recognized as Site Studio links (or those requiring Site Studio processing) are grouped and sent to Site Studio as a batch. Consequently, refreshes are more efficient, but abort requests are unresponsive during this time because Site Studio is unaware of aborts and total error counts.

However, Site Studio is aware of the number of errors it has encountered in the current batch. For this reason, the Link Manager's abort calculation can not take place in all situations and the error configuration values (percent and threshold) are simply suggestions to Link Manager for when an abort should occur. Using LkRefreshBatchSize, however, enables you to more accurately control the abort receptivity during refresh activities that involve Site Studio link batches.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

LkRefreshBatchSize=200

See Also


LkRefreshErrorPercent

Used with Link Manager functionality.

This variable is used with LkRefreshErrorThreshold to compute if the refresh activity should be aborted. When the refresh activity processes more links than the threshold value, Link Manager calculates the proportion of errors. If the number of errors exceeds the percent value, the refresh activity is aborted.

The percent value is set to 10 by default.

Note:

If you choose to set a value for LkRefreshErrorsAllowed, it could override the combination of threshold and percent values. For example, if the value is less than the calculated threshold/percent value for links/errors, then the refresh activity could abort even if the number of links processed does not exceed the threshold limit. Therefore, it is recommended that you use either the LkRefreshErrorsAllowed configuration setting or the combination of the LkRefreshErrorThreshold and LkRefreshErrorPercent configuration settings.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

LkRefreshErrorPercent=20

See Also


LkRefreshErrorsAllowed

Used with Link Manager functionality.

This variable sets an absolute error count for refresh processes. When the set number of errors is encountered, the refresh activity aborts. This configuration setting is not used by default.

Note:

If you choose to set a value for LkRefreshErrorsAllowed, it could override the combination of threshold and percent values. For example, if the value is less than the calculated threshold/percent value for links/errors, then the refresh activity could abort even if the number of links processed does not exceed the threshold limit. Therefore, it is recommended that you use either the LkRefreshErrorsAllowed configuration setting or the combination of the LkRefreshErrorThreshold and LkRefreshErrorPercent configuration settings.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

LkRefreshErrorsAllowed=10

See Also


LkRefreshErrorThreshold

Used with Link Manager functionality.

This variable is used with LkRefreshErrorPercent to compute if the refresh activity should be aborted. When the refresh activity processes more links than the threshold value, Link Manager calculates the proportion of errors. If the number of errors exceeds the percent value, the refresh activity is aborted.

The threshold value is set to 100 by default.

Note:

If you choose to set a value for LkRefreshErrorsAllowed, it could override the combination of threshold and percent values. For example, if the value is less than the calculated threshold/percent value for links/errors, then the refresh activity could abort even if the number of links processed does not exceed the threshold limit. Therefore, it is recommended that you use either the LkRefreshErrorsAllowed configuration setting or the combination of the LkRefreshErrorThreshold and LkRefreshErrorPercent configuration settings.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

LkRefreshErrorThreshold=200

See Also


MaxConversionCacheSizeInMegs

Defines the maximum size of the Dynamic Converter cache, in megabytes.

When a cleanup scan is run (see DatedCacheIntervalDays), the cache is cleaned up according to this setting as follows:

  • If the Dynamic Converter cache is larger than this size, the oldest cached files (determined by last access date) are deleted until the cache is smaller than this size.

  • If the Dynamic Converter cache is smaller than this size, only files that are older than the ConversionCacheExpirationPeriodInDays and were not converted using conversion rules (forced or up front conversion) are deleted.

Default is 10,000 (10 gigabytes).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

MaxConversionCacheSizeInMegs=5,000

See Also


MaxNumRecursiveStepDefinitions

Specifies the maximum number of levels that recursion can be used when defining a custom conversion.

A custom conversion engine can call another conversion, but to prevent loops, this setting limits the number of levels of such calls.

Default is 6.

Type and Usage

Location

IntradocDir/ucm/ibr/bin/config.cfg

Example

Used as a configuration entry:

MaxNumRecursiveStepDefinitions=3

MaxSearchableSubfolders

Specifies the maximum number of subfolders that will be searched within a hierarchy of contribution folders (for example, when searching with a GET_SEARCH_RESULTS query). By default the maximum number of subfolders that will be searched is limited to 500.

Note:

Setting the environment variable to a higher value can result in a significant performance degradation and/or a query larger than the maximum limit allowed in SQL (usually 32K), in which case the query will fail. This is why the variable exists and is set to a modest value.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

Example

MaxSearchableSubfolders=500

MSPubexePath

Defines the path for the MS Publisher executable file.

Returns the path as a string.

Default is an empty string.

Type and Usage

Location

  • Shared Inbound Refinery Configuration screen, Paths tab, MS Publisher Executable Path

  • IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

MSPubexePath=c:/Program Files/Microsoft Publisher/mspub.exe

NeverTimeoutForcedConversionsTemplateChange

Defines whether Dynamic Converter will reconvert a file when the template or layout has changed.

When set to TRUE, files that were converted by forced or up front conversion will not be reconverted when the template or layout is changed.

If a conversion rule is changed to use a different template or layout, the normal evaluation logic is used.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

NeverTimeoutForcedConversionsTemplateChange=true

See Also


NumAdditionalRenditions

Used by the Thumbnails program to set the number of renditions of a content item.

When set to 0, thumbnails are not created on search results pages.

When set to 1, thumbnails are created on search results pages.

Default is 0.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used to determine if useThumbnails should be set:

<@dynamichtml searchapi_result_definitions@>
    <$if NumAdditionalRenditions and NumAdditionalRenditions > 0$>
        <$useThumbnails=1$>
    <$endif$>
<@end@>

OpenOfficeListenerPort

Defines the socket port for the OpenOffice listener.

This setting is used by PDF Converter's OpenOffice connection string:

uno:socket,host=<OpenOfficeListenerURL>, port=<OpenOfficeListenerPort>;urp;StarOffice.ServiceManager

Default is 8100.

Type and Usage

Location

IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

OpenOfficeListenerPort=8110

See Also


OpenOfficeListenerURL

Defines the URL (socket hostname) for the OpenOffice listener.

This setting is used by PDF Converter's OpenOffice connection string:

uno:socket,host=<OpenOfficeListenerURL>,port=<OpenOfficeListenerPort>;urp; StarOffice.ServiceManager

Default is localhost.

Type and Usage

Location

IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

OpenOfficeListenerURL=/mycomputer/localhost

See Also


OpenOfficePath

Defines the path for the OpenOffice listener.

If PDF Converter cannot connect to the OpenOffice connection, it attempts to open the listener defined by this path.

Default is an empty string.

Type and Usage

Location

IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

OpenOfficePath=C:\Program Files\Open Office.org.1.0.1\program\quickstart.exe

PageMakerExePath

Defines the path for the Adobe PageMaker executable file.

Returns the path as a string.

Default is an empty string.

Type and Usage

Location

  • Shared Inbound Refinery Configuration screen, Paths tab, PageMaker Executable File Path

  • IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

PageMakerExePath=c:/Program Files/Adobe/PageMaker 6.5/pagemaker.exe

PostConversionTimeOut

Defines the default post-conversion timeout.

Returns the post-conversion timeout values.

This variable must be followed by one of these flags:

Flag Description
#factor This value is multiplied by the file size to determine the amount of time allowed for post-conversion processing. (The resulting time is limited by the #max and #min flags.) The default value is 1. Increase this value for busy or slow systems.
#max Specifies the maximum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for any post-conversion processes to complete. The default time is 10 seconds.
#min Specifies the minimum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for any post-conversion processes to complete. The default time is 1 second.

Type and Usage

Location

  • Shared Inbound Refinery Configuration screen, Timeout Values tab, Post PDF Production Timeout

  • IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

PostConversionTimeOut#factor=1

PostprocessPDFPath

Defines the path to an executable that is used to process PDF files after conversion.

The PDF file path is the only command line parameter.

The specified file must be a Win32 executable.

This process is invoked after the conversion to PDF and before the optimization of the PDF. Because this process is invoked once for each file that is processed by the Oracle WebCenter Content: Inbound Refinery system, it could also be used for other events that might need to be synchronized to the conversion of a file. If the value is not empty, the Oracle WebCenter Content: Inbound Refinery system will attempt to run the process.

Default is an empty string.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, General tab, Post PDF Production Path

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

PostprocessPDFPath=c:/domain/IdcRefinery/ConversionProcess/IDCWaterPost.exe

PostscriptPrinterName

Specifies the name of the printer that is used to convert files to PostScript.

This must be the name of a valid PostScript printer.

Default is IDC PDF Converter.

Type and Usage

Location

IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

PostscriptPrinterName=Acrobat Distiller

PowerPointPrintOutput

Defines how Microsoft PowerPoint content items are converted.

When set to slide, each page of the PDF file contains one slide.

When set to notes, each page of the PDF file contains a slide with its notes.

When set to handout, each page of the PDF file contains six slides.

Default is slide.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Convert in PowerPoint format options

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

PowerPointPrintOutput=notes

See Also


PreconversionPath

Defines the path to an executable that is used to process files before conversion.

The specified file must be a Win32 executable.

Default is an empty string.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Legacy Conversions tab, Preconversion Path

  • DomainHome/urm/ibr/connections/main/intradoc.cfg

Example

Used as a configuration entry:

PreconversionPath=c:/out/preconversion.bat

PreconversionWaitTime

Defines the preconversion timeout.

Returns the preconversion timeout value.

This variable must be followed by one of these flags:

Flag Description
#factor This value is multiplied by the file size to determine the amount of time allowed for preconversion processes. (The resulting time is limited by the #max and #min flags.) The default value is 1. Increase this value for busy or slow systems.
#max Specifies the maximum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for the preconversion process to complete. The default time is 10 seconds.
#min Specifies the minimum time in seconds that the Oracle WebCenter Content: Inbound Refinery system waits for the preconversion process to complete. The default time is 1 second.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Legacy Conversions tab, Pre-Converter Timeout

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

PreconversionWaitTime#max=60

PreviewOutputExtension

Defines the file extension output from Content Publisher that is to be used in HTML Preview.

Default is HCSP.

Type and Usage

Location

DomainHome/ucm/cs/bin/intradoc.cfg

Example

Used as a configuration entry:

PreviewOutputExtension=jsp

PreviewPath

Defines the path for HTML Preview executable.

The tcpreview.exe file resides in the Content Publisher installation directory.

Type and Usage

Location

DomainHome/ucm/cs/bin/intradoc.cfg

Example

Used as a configuration entry:

PreviewPath=C:/Program Files/Oracle Content Publisher/tcpreview.exe

PrinterPortPath

Defines the location of the PostScript file created by the Oracle WebCenter Content: Inbound Refinery system.

This setting must match the port setting of the printer used by the Inbound Refinery system.

Default is c:/temp/idcoutput.ps.

Type and Usage

Location

IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

PrinterPortPath=c:/temp/idcrefinery/idcoutput.ps

See Also


ProcessExcelUrlHyperlinks

Enables the processing of URL hyperlinks in Microsoft Excel content items.

  • When set to TRUE, URL hyperlinks in Excel files are processed.

  • When set to FALSE, URL hyperlinks in Excel files are not processed.

Default is FALSE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Process Excel URL links

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessExcelUrlHyperlinks=true

ProcessInDesignBookMarks

Enables the conversion of internal document links in Adobe InDesign content items.

  • When set to TRUE, internal document links in Adobe InDesign files are processed.

  • When set to FALSE, internal document links in Adobe InDesign files are not processed.

Default is TRUE.

Type and Usage

Location

IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessInDesignBookmarks=false

See Also


ProcessInDesignHyperlinks

Enables the conversion of URL links in Adobe InDesign content items.

  • When set to TRUE, URL links in Adobe InDesign files are processed.

  • When set to FALSE, URL links in Adobe InDesign files are not processed.

Default is TRUE.

Type and Usage

Location

IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessInDesignHyperlinks=false

See Also


ProcessInDesignInternalPDFThumbnail

Enables the creation of PDF page thumbnails when converting Adobe InDesign content items.

  • When set to TRUE, the PDF file will include page thumbnails.

  • When set to FALSE, the PDF file will not include page thumbnails.

This setting does not affect the creation of thumbnails on search results pages.

Default is TRUE.

Type and Usage

Location

IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessInDesignInternalPDFThumbnail=false

See Also


ProcessInDesignLinkUpdate

Enables an update of all links in Adobe InDesign content items before conversion.

  • When set to TRUE, links in Adobe InDesign files are updated before conversion. If linked objects are not available, the conversion will fail.

  • When set to FALSE, links in Adobe InDesign files are not updated before conversion.

Default is FALSE.

Type and Usage

Location

IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessInDesignLinkUpdate=true

See Also


ProcessInDesignPDFCompatibility50

Sets the version of the PDF files that PDF Converter produces from Adobe InDesign content items.

  • When set to TRUE, PDF Converter produces PDF version 1.4 (Acrobat 5.0 compatible) files from Adobe InDesign files.

  • When set to FALSE, PDF Converter produces PDF version 1.3 (Acrobat 4.0 compatible) files from Adobe InDesign files.

Default is FALSE.

Type and Usage

Location

IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessInDesignPDFCompatibility50=true

ProcessPowerpointHyperlinks

Enables the processing of hyperlinks in Microsoft PowerPoint content items.

  • When set to TRUE and the PowerPointPrintOutput setting is set to SLIDE, the following hyperlinks in PowerPoint files are processed:

    • URL links

    • Next slide

    • Previous slide

  • When set to FALSE, hyperlinks in PowerPoint files are not processed.

If the PowerPointPrintOutput setting is set to NOTES or HANDOUT, hyperlinks in PowerPoint files are not processed.

Default is FALSE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Process PowerPoint Hyperlinks

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessPowerpointHyperlinks=true

See Also


ProcessVisioInternalHyperlinks

Enables the conversion of internal hyperlinks in Microsoft Visio content items.

  • When set to TRUE, internal hyperlinks in Visio files are processed.

  • When set to FALSE, internal hyperlinks in Visio files are not processed.

Default is FALSE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Process internal Visio links

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessVisioInternalHyperlinks=true

See Also


ProcessVisioUrlHyperlinks

Enables the conversion of URL links in Microsoft Visio content items.

  • When set to TRUE, URL links in Visio files are processed.

  • When set to FALSE, URL links in Visio files are not processed.

Default is FALSE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Process Visio URL links

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessVisioUrlHyperlinks=true

See Also


ProcessWordBookMarks

Enables the conversion of page reference bookmarks in Microsoft Word content items.

  • When set to TRUE, page reference bookmarks in Microsoft Word files are converted to PDF bookmarks. (All other types of bookmarks are ignored.)

  • When set to FALSE, bookmarks in Microsoft Word files are not processed.

Default is TRUE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Process document bookmarks

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessWordBookMarks=false

See Also


ProcessWordComments

Enables the conversion of comments in Microsoft Word content items to PDF notes.

  • When set to TRUE, comments in Microsoft Word files are converted to PDF notes.

  • When set to FALSE, comments in Microsoft Word files are not processed.

Default is FALSE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Process document comments to PDF notes

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessWordComments=true

See Also


ProcessWordEmailLinks

Enables the conversion of e-mail hyperlinks in Microsoft Word content items.

  • The ProcessWordUrlHyperlinks setting must be TRUE for this setting to be valid.

  • When set to TRUE, e-mail hyperlinks in Microsoft Word files are processed.

  • When set to FALSE, e-mail hyperlinks in Microsoft Word files are not processed.

Default is FALSE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Process mailto links

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessWordEmailLinks=true

See Also


ProcessWordFootEndNote

Enables the conversion of footnotes and endnotes in Microsoft Word content items to hyperlinks.

  • When set to TRUE, footnotes and endnotes in Microsoft Word files are converted to hyperlinks.

  • When set to FALSE, footnotes and endnotes in Microsoft Word files are not processed.

Default is FALSE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Process document links to footnotes and endnotes

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessWordFootEndNote=true

See Also


ProcessWordHeadings

Enables the conversion of standard headings in Microsoft Word content items to PDF bookmarks.

  • When set to TRUE, standard heading paragraph styles (Heading 1 through Heading 9 and any custom styles based on these standard styles) in Microsoft Word files are converted to PDF bookmarks.

  • If a table of contents has already been processed using the ProcessWordToc setting, then this setting is ignored and headings will not be converted to bookmarks.

  • When set to FALSE, heading styles in Microsoft Word files are not processed.

Default is TRUE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Process heading styles to PDF bookmarks

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessWordHeadings=false

See Also


ProcessWordHyperlinks

Enables the conversion of hyperlinks in Microsoft Word content items.

  • When set to TRUE, all types of hyperlinks in Microsoft Word files are processed.

  • When set to FALSE, hyperlinks in Microsoft Word files are not processed.

Default is TRUE.

Type and Usage

Location

IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessWordHyperlinks=true

See Also


ProcessWordToc

Enables the conversion of tables of contents in Microsoft Word content items to PDF bookmarks.

  • When set to TRUE, tables of contents entries that are automatically generated in Microsoft Word files are converted to PDF bookmarks.

  • When set to FALSE, tables of contents in Microsoft Word files are not processed. (However, if the table of contents entries have hyperlinks, they will be processed according to the ProcessWordUrlHyperlinks setting.)

Default is FALSE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Process Table of Contents to PDF bookmarks

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessWordToc=true

See Also


ProcessWordUrlHyperlinks

Enables the conversion of URL hyperlinks in Microsoft Word content items.

  • When set to TRUE, URL hyperlinks in Microsoft Word files are processed.

  • When set to FALSE, URL hyperlinks in Microsoft Word files are not processed.

Default is TRUE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, Native Options tab, Process URL links

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

ProcessWordUrlHyperlinks=false

See Also


pucDefaultTime

Specifies how the time is entered into the date/time fields when using the pop-up calendar. If this option is not set, the time defaults to midnight of the selected date.

This is a string value which can be set in the following ways:

  • current: sets the time equivalent to the client computer's clock.

  • any time, expressed in the system locale format. Missing values are interpreted as a zero. Missing AM/PM designations are interpreted as using 24-hour format. For example, 1:15 PM, 01:15 PM, and 13:15 are interpreted the same within a system locale that designates AM and PM.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

pucDefaultTime=current

pucEnableOnSearch

If set to TRUE, specifies if the pop-up calendar is available on a search page. If set to FALSE, disables the pop-up calendar on the search page.

The default is TRUE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

pucEnableOnSearch=false

pucHideTimeInDateFields

Specifies if date fields display only the date or the date and time.

  • If set to TRUE, disables the display of the time in a date field and forces the Oracle WebCenter Content Server instance to parse the check-in time as midnight of the selected date, regardless of how pucDefaultTime is set.

  • If set to false, displays the time in a date field.

The default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

pucHideTimeInDateFields=true

See Also


pucUseMonthLocale

Determines how the month names are displayed in the pop-up calendar.

This is a string value which can be set in the following ways:

  • short: truncates the month name based on user locale. For example, January is truncated to Jan, February to Feb, and so on.

  • long: displays the full month name based on user locale.

Default is long.

Type and Usage

Example

pucUseMonthLocale=short

See Also


pucUseWeekdayLocale

Determines how the day names are displayed in the pop-up calendar.

This is a string value which can be set in the following ways:

  • 1char: uses the first letter of the day. Note that this starts with the numeral '1', not a lower-case 'L'.

  • short: uses two characters to represent the day name.

  • medium: uses the standard three-character day names

  • long: displays the full name based on user locale.

Default is long.

Type and Usage

Example

pucUseWeekdayLocale=short

See Also


pucXOffset

Specifies the horizontal location of the pop-up calendar on the page in pixels, relative to the default position. This is a value set as an integer. The default is 0.

Type and Usage

Example

pucXOffset=10

See Also


pucYOffset

Specifies the vertical location of the pop-up calendar on the page in pixels, relative to the default position. This is a value set as an integer. The default is 0.

Type and Usage

Example

pucYOffset=10

See Also


pucZIndex

Specifies the z-ordering object position of the pop-up calendar layer. The larger the number, the higher the placement within the page layer positions. Use a positive number greater than any other z-index style attribute specified on the page to ensure the calendar is displayed over other elements.

This is specified as an integer value. Default is 0.

Type and Usage

Example

pucZIndex=10

QueueDir

Defines the path to the working directory for the Oracle WebCenter Content: Inbound Refinery queue.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

QueueDir=x:/domain_refinery/

RecordsManagementDenyAuthorFreePassOnRMSecurity

When a content item is placed in an ACL-restricted contribution folder (RW recordsmanager alias), users have only RW access, except for the author who can delete the item. Setting this configuration variable to true disallows deletion of the item by the author, restricting the author to only RW access.

  • If set to TRUE, authors are not allowed to delete content they authored.

  • If set to FALSE, authors are allowed to delete content they authored.

The default is FALSE.

Restart WebCenter Content for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

RecordsManagementDenyAuthorFreePassOnRMSecurity=true

RecordsManagementNumberOverwriteOnDelete

Sets the number of disk scrubbing passes used for a destroy action.

The default is 2.

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

RecordsManagementNumberOverwriteOnDelete=4

RmaAddDocWhereClauseForScreening

Allows users with the Records Administrator role to screen for frozen items to which they do not have access (through ACLs) on the screening page or the Freeze Information Page.

  • If set to FALSE, frozen items can be screened.

  • If set to TRUE, frozen items cannot be screened.

The default is FALSE.

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

RmaAddDocWhereClauseForScreening=true

RmaAllowKeepOrDestroyMetadataOption

This variable enables the option to keep or destroy metadata when using the following disposition actions: Delete All Revisions, Accession, Archive, Move, and Transfer.

  • If set to TRUE, enables the use of the keep/destroy option.

  • If set to FALSE, disables the use of this option.

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

RmaAllowKeepOrDestroyMetadataOption=true

RmaEnableFilePlan

This variable enables File Plan contribution folder structure functionality.

  • If set to FALSE, disables the contribution folder structure used with MoReq2 (Model Requirements for the Management of Electronic Records) file plans.

  • If set to TRUE, enables contribution folder structure for use with MoReq2 file plans.

The default is FALSE.

Restart WebCenter Content for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

RmaEnableFilePlan=true

RmaEnableFixedClones

This variable enables the fixed clone functionality, which allows the creation of record clones of content revisions.

  • If set to FALSE, enables fixed clone functionality.

  • If set to TRUE, disables fixed clone functionality.

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

RmaEnableFixedClones=false

RmaEnablePostFilterOnScreening

This variable enables additional security on screening results. If a user does not have appropriate security for an item in a screening result list, that item is hidden from view.

  • If set to TRUE, enables filtering on screening results.

  • If set to FALSE, disables additional security on screening results.

The default is TRUE.

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

RmaEnablePostFilterOnScreening=false

RmaFilePlanVolumePrefix and RmaFilePlanVolumeSuffix

These variables are used to define the naming convention for volumes. The usual convention is prefix+timestamp+suffix. Use these variables to define the prefix and suffix. If neither is defined, a prefix of volume_ is used by default.

  • RmaFilePlanVolumePrefix=value: Sets the prefix used to value.

  • RmaFilePlanVolumeSuffix=value: Sets the suffix used to value.

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg


RmaFixedClonesTitleSuffix

This variable sets the suffix that is automatically appended to a fixed clone content item.

Default: RmaFixedClonesTitleSuffix=fixed_clone

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg


RMAHideExternalFieldsFromCheckInUpdate

Use this variable to hide external fields on the Checkin and Update pages.

  • If set to TRUE, hides external fields on the Checkin and Update pages.

  • If set to FALSE, displays external fields on the Checkin and Update pages.

The default is TRUE.

Restart Oracle UCM for this variable to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

RMAHideExternalFieldsFromCheckInUpdate=false

RMAHideExternalFieldsFromSearchInfo

Specifies whether to hide external fields on the Search and Content Information pages. The default is TRUE.

  • If set to TRUE, hides external fields on the Search and Content Information pages.

  • If set to FALSE, displays external fields on the Search and Content Information pages.

The default is TRUE.

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

RMAHideExternalFieldsFromSearchInfo=false

RmaNotifyDispReviewerAndCatAuthor

Controls who is notified when events are triggered by a disposition rule.

  • If set to TRUE, both the specified notification reviewer and the original category author receive e-mail notifications of the event.

  • If set to FALSE, only the category author receives e-mail.

The default is TRUE.

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

RmaNotifyDispReviewerAndCatAuthor=false

RmaNotifyReviewerAndAlternateReviewer

Controls if an alternate user can perform review actions and process assigned disposition events.

  • If set to TRUE, both the original user and the alternative reviewer receive e-mail notifications about the action.

  • If set to FALSE, only the alternative reviewer receives e-mail.

The default is TRUE.

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

RmaNotifyReviewerAndAlternateReviewer=false

rule:IsFragmentOnly

Specifies that a particular forced conversion rule creates a fragment in Dynamic Converter.

Fragments are pieces of content that will be included in another content item. Fragments generally do not include <HTML> or <BODY> tags, and are not intended to be viewed by themselves.

When this variable is set to 1, the specified forced conversion rule converts files to fragments.

The specified forced conversion rule must be included in the ForcedConversionRules setting.

There is no default.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Specifies that the RuleA forced conversion rule converts files to fragments:

RuleA:IsFragmentOnly=1
ForcedConversionRules=RuleA

See Also


SctAutoTruncateDataStrings

Specifies that the reduction process truncates data strings to fit into the corresponding table column for Content Tracker.

The default is FALSE.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctAutoTruncateDataStrings=true

SctComponentDir

Specifies the path to the directory where Content Tracker is installed.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctComponentDir=DomainHome/ucm/cs/data/contenttracker/

SctDebugLogEnabled

Specifies use of Java code execution trace for Content Tracker.

If set to TRUE, enables Java code execution trace for Content Tracker. Used with SctDebugLogFilePath.

The default is FALSE.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctDebugLogEnabled=true

See Also

"SctDebugLogFilePath"


SctDebugLogFilePath

Specifies the directory for Java code execution trace for Content Tracker. Used with SctDebugLogEnabled.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

DomainHome/ucm/cs/data/contenttracker/log/SCT_DEBUG_TRACE.log

See Also

"SctDebugLogEnabled"


SctDebugServiceBinderDumpEnabled

Controls if the Content Tracker service handler filter writes out the service DataBinder objects into dump files. These files can be used as diagnostic tools when developing field map sets for extended service logging.

  • If set to FALSE, prevents the Content Tracker service handler filter from writing out the DataBinder objects into dump files.

  • If set to TRUE, configures the Content Tracker service handler filter to write out the DataBinder objects into dump files. Use the dump files to view what data is available at the time the particular service events are recorded.

The default is FALSE.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctDebugServiceBinderDumpEnabled=true

SctDoNotArchive

Specifies performance optimization for Content Tracker to function as efficiently as possible for use in high-volume production environments. Content Tracker collects and records only content access event data. This excludes information gathering on non-content access events like searches or the collection and synthesis of user profile summaries.

  • If set to TRUE, Content Tracker ensures that the database tables contain only the most current data and expired table rows are discarded rather than archived. This applies to all Content Tracker database tables.

    By default, only the SctAccessLog table is populated and expired rows are not archived. However, if both SctTrackContentAccessOnly and SctDoNotArchive are disabled, all tables are populated and their expired data archived.

  • If set to FALSE, Content Tracker database tables contain all recorded data and expired table rows are not discarded.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctDoNotArchive=true

SctDoNotPopulateAccessLogColumns

Specifies a list of columns that Content Tracker should not populate in the SctAccessLog table. This variable supports performance optimization for Content Tracker to function as efficiently as possible for use in high-volume production environments. Content Tracker collects and records only content access event data. This excludes information gathering on non-content access events like searches or the collection and synthesis of user profile summaries.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctDoNotPopulateAccessLogColumns=SctParentSequence,c_ip,cs_username

SctExternalUserLogEnabled

Specifies whether Content Tracker monitor external user logins and automatically propagate their role and account information to the UserSecurityAttributes table. These authenticated users are qualified based on their user roles and accounts.

Regardless of whether the SctExternalUserLogEnabled configuration variable is enabled or disabled, all the of the content item access information for external users is tracked and recorded. But when this variable is enabled, it ensures that this data is included in reports that explicitly correlate externally authenticated user names with their associated user roles and accounts. Specifically, the Top Content Items by User Role report and the Users by User Role report include all of the content item access activity by external users.

  • If set to FALSE, disables replication of external user account and role information to the UserSecurityAttributes table.

  • If set to TRUE, enables replications of external user account and role information to the UserSecurityAttributes table.

The default is TRUE.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctExternalUserLogEnabled=true

SctFilterPluginLogDir

Specifies the path to the directory where the filter plugin stores the event logs for Content Tracker.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

DomainHome/ucm/cs/data/contenttracker/data/

SctIgnoreDirectories

Directs the filter plugin to disregard URLs contained within the listed directory node.

The default is DomainHome/ucm/cs/resources/;DomainHome/ucm/cs/common/

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctIgnoreFileTypes

Directs the filter plugin to disregard URLs with the listed file types. The value is a list of comma-delimited file types.

The default is gif,jps,js,css.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctIgnoreFileTypes=gif,jps

SctLogDir

Specifies the path to the directory or directories where Content Tracker looks for raw event logs, such as sctLog. The path can have multiple values, separated by semi-colons. For example, directory1;directory2;...;directoryn

The default is DomainHome/ucm/cs/data/contenttracker/data/

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctLogEnabled

Specifies that service handler filters and web server filter plugin track all events and create event logs. This is the Content Tracker master on/off switch.

  • If set to TRUE, the service handler filters and web server filter plugin track all events and create event logs.

  • If set to FALSE, the service handler filters and web server filter plugin ignore all events and create no logs.

The default is TRUE.

Important:

This variable must be set using the Content Tracker Admin Applet (the Data Engine Control Center), which is accessed through the Oracle WebCenter Content Server interface.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctLogSecurity

Specifies that the filter plugin record IMMEDIATE_RESPONSE_PAGE events in the sctSecurityLog, and the reduction process to read the event log.

  • If set to TRUE, the filter plugin records IMMEDIATE_RESPONSE_PAGE events in the sctSecurityLog, and the reduction process reads the event log.

  • If set to FALSE, the filter plugin does not record IMMEDIATE_RESPONSE_PAGE events in the sctSecurityLog, and the reduction process does not read the event log.

The default is TRUE.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctLogSecurity=true

SctMaxRecentCount

Specifies the maximum number of days worth of reduced data kept in the Recent state. Overflow from Recent is moved to the Archive state.

The default is 60.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctMaxRecentCount=3

SctMaxRereadTime

Specifies the maximum number of seconds that can occur between consecutive references by a particular user to a particular content item (for example, a PDF file) and have the adjacent references be considered a single sustained access. Consecutive references that occur further apart in time count as separate accesses.

The default is 3600.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctMaxRereadTime=4200

SctReductionAvailableDatesLookback

Used with SctReductionRequireEventLogs to limit Available Dates range for Content Tracker event logs. Unit equals days. Zero equals unlimited.

The default is 0.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctReductionAvailableDatesLookback=10

SctReductionLogDir

Specifies the path to the directory where the Content Tracker reduction logs are stored.

The default is DomainHome/ucm/cs/data/contenttracker/log/

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctReductionRequireEventLogs

Specifies that Content Tracker performs reduction in association with event logs. Used in Detached configurations.

  • If set to TRUE, Content Tracker performs reduction only when event logs are found.

  • If set to FALSE, Content Tracker performs reduction even if no event logs are found.

The default is TRUE.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctReductionRequireEventLogs=false

SctrEnableSecurityCheck

Specifies that Content Tracker Reports uses one of two security modes: secure and non-secure. The security checks preference provides the option to employ individual user roles and account information to restrict the visibility of content items information in report results. This option enables you to control what content items (and metadata) that users can see in their generated reports. Ideally, users should not see anything through Content Tracker Reports that they could not find using an Oracle WebCenter Content Server search.

  • If set to TRUE, information in any generated report is filtered (made secure) based on the user's role and account privilege.

    If Access Control Lists (ACLs) are enabled on your Oracle WebCenter Content Server instance, the secure mode option in Content Tracker Reports does not work. On an ACL-based system, the secure mode must be disabled. In this case, it is possible for users other than a system administrator to see information about content items that they would not otherwise be authorized to access and view.

  • If set to FALSE, information in generated reports is the same as what a user would see with an Oracle WebCenter Content Server search.

The default is FALSE.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctrEnableSecurityCheck=true

SctScheduledReductionEnable

Selects which Oracle WebCenter Content Server instance performs data reduction for Content Tracker. Used in multi-JVM configurations.

  • If set to TRUE, the owning Oracle WebCenter Content Server instance performs data reduction.

  • If set to FALSE, the owning Oracle WebCenter Content Server instance does not perform data reduction.

The default is TRUE.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctScheduledReductionEnable=false

SctSimplifyUserAgents

Specifies performance optimization for Content Tracker to function as efficiently as possible for use in high-volume production environments. Content Tracker collects and records only content access event data. This excludes information gathering on non-content access events like searches or the collection and synthesis of user profile summaries.

  • If set to TRUE, Content Tracker minimizes the information that is stored in the cs_userAgent column of the SctAccessLog table.

  • If set to FALSE, Content Tracker does not minimize the information that is stored in the cs_userAgent column of the SctAccessLog table.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctSimplifyUserAgents=true

SctSnapshotEnable

Enables Snapshot functions for Content Tracker.

  • If set to TRUE, enables Snapshot functions. This is set from the Data Engine Control Center.

  • If set to FALSE, disables Snapshot functions.

The default is FALSE.

Important:

This variable must be set using the Content Tracker Admin Applet (the Data Engine Control Center), which is accessed through the Oracle WebCenter Content Server interface.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctSnapshotLastAccessEnable

Enables or disables the Last Access Date Snapshot function for Content Tracker.

  • If set to TRUE, enables the Last Access Date Snapshot function. This is set from the Data Engine Control Center.

  • If set to FALSE, disables the function.

The default is FALSE.

Important:

This variable must be set using the Content Tracker Admin Applet (the Data Engine Control Center), which is accessed through the Oracle WebCenter Content Server interface.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctSnapshotLastAccessField

Specifies the metadata field name for Last Access Date (xLastAcccessDate) for Content Tracker.

The default is none.

Important:

This variable must be set using the Content Tracker Admin Applet (the Data Engine Control Center), which is accessed through the Oracle WebCenter Content Server interface.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctSnapshotLongCountEnable

Enables or disables the "Long" interval access count Snapshot function for Content Tracker.

  • If set to TRUE, enables the Long interval access count Snapshot function. This is set from the Data Engine Control Center.

  • If set to FALSE, disables the function.

The default is FALSE.

Important:

This variable must be set using the Content Tracker Admin Applet (the Data Engine Control Center), which is accessed through the Oracle WebCenter Content Server interface.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctSnapshotLongCountField

Specifies the metadata field name for Long Internal Count (xAccessesInLast90Days) for Content Tracker. This field name is set from the Data Engine Control Center.

The default is none.

Important:

This variable must be set using the Content Tracker Admin Applet (the Data Engine Control Center), which is accessed through the Oracle WebCenter Content Server interface.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctSnapshotLongCountInterval

Specifies the number of days for the Long Interval Count (xAccessesInLast90Days) for Content Tracker. This value is set from the Data Engine Control Center.

The default is none.

Important:

This variable must be set using the Content Tracker Admin Applet (the Data Engine Control Center), which is accessed through the Oracle WebCenter Content Server interface.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctSnapshotShortCountEnable

Enables or disables the Short Interval Access Count Snapshot function for Content Tracker. This is set from the Data Engine Control Center.

  • If set to TRUE, enables the Short Interval Access Count Snapshot function.

  • If set to FALSE, disables the function.

The default is FALSE.

Important:

This variable must be set using the Content Tracker Admin Applet (the Data Engine Control Center), which is accessed through the Oracle WebCenter Content Server interface.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctSnapshotShortCountField

Specifies the metadata field name for Short Internal Count (xAccessesInLast10Days) for Content Tracker. Set from the Data Engine Control Center.

The default is none.

Important:

This variable must be set using the Content Tracker Admin Applet (the Data Engine Control Center), which is accessed through the Oracle WebCenter Content Server interface.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctSnapshotShortCountInterval

Specifies the number of days for Short Internal Count (xAccessesInLast10Days) for Content Tracker. Set from the Data Engine Control Center.

The default is none.

Important:

This variable must be set using the Content Tracker Admin Applet (the Data Engine Control Center), which is accessed through the Oracle WebCenter Content Server interface.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg


SctTrackContentAccessOnly

Specifies performance optimization for Content Tracker to function as efficiently as possible for use in high-volume production environments. Content Tracker collects and records only content access event data. This excludes information gathering on non-content access events like searches or the collection and synthesis of user profile summaries.

When enabled, only content access events are recorded. This is the default.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctTrackContentAccessOnly=true

SctUseGMT

Sets Content Tracker to convert logged event times to Universal Coordinated Time.

  • If set to TRUE, logged event times are converted to Universal Coordinated Time.

  • If set to FALSE, logged event times use local time.

The default is FALSE.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/cs/data/contenttracker/config/sct.cfg

Example

Used as a configuration entry:

SctUseGMT=true

SecondaryConversionStepName

Defines the name of the backup conversion step that the Oracle WebCenter Content: Inbound Refinery system will use if the native step conversion step fails.

Default is OIXConverter (Outside In).

AllowSecondaryConversion must be set to TRUE.

Type and Usage

Location

IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

SecondaryConversionStepName=OIXConverter

See Also


ShowContentForStorageBrowse

Defines whether content items are displayed when browsing storage locations for Physical Content Manager (PCM).

  • If set to TRUE, permits content items to be displayed. If storage locations contain large numbers of items (that is, more than 100 per location), display time can be slowed.

  • If set to FALSE, content items are hidden in storage locations.

Default is TRUE.

Restart Oracle UCM for this settings to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

ShowContentForStorageBrowse=false

ShowEmailMetadataMenu

Defines whether the administrative UI is displayed when the EmailMetadata component is installed and enabled on an Oracle WebCenter Content: Records instance.

  • If set to TRUE, permits the administrative UI to be displayed.

  • If set to FALSE, the administrative UI is hidden.

The default is FALSE.

Restart Oracle UCM for this settings to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/EmailMetadata/emailmetadata_environment.cfg

Example

Used as a configuration entry:

ShowEmailMetadataMenu=true

ShowHyperlinkBox

Defines whether a box is placed around hyperlinks in PDF files.

  • When set to TRUE, a box is placed around hyperlinks in PDF files.

  • When set to FALSE, a box is not placed around hyperlinks in PDF files.

Default is FALSE.

Type and Usage

Location

IntradocDir/IdcRefinery/shared/idcrefinery.cfg

Example

Used as a configuration entry:

ShowHyperlinkBox=true

SimpleProfilesEnabled

This variable enables the Simple Profile functionality.

  • When set to TRUE, enables Simple Profile functionality.

  • When set to FALSE, disables Simple Profile functionality.

Restart WebCenter Content for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

SimpleProfilesEnabled=true

TimeoutChangedTemplateForcedConversionsInMins

Defines the minimum interval in minutes at which Dynamic Converter will reconvert a file when the template or layout has changed.

  • When set to a positive value, forced or up front conversions will be reconverted because of a change to the template or layout only after the time specified by this setting has passed.

  • If a conversion rule is changed to use a different template or layout, the normal evaluation logic is used.

  • This setting is ignored if the NeverTimeoutForcedConversionsTemplateChange setting is TRUE.

  • When set to 0, the TimeoutMismatchedForcedConversionsInMins setting is used.

Default is 0.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

TimeoutChangedTemplateForcedConversionsInMins=1

See Also


TimeoutMismatchedForcedConversionsInMins

Defines the minimum interval in minutes at which Dynamic Converter will reconvert a file when the source document, template, or layout has changed.

  • When set to a positive value, forced or up front conversions will be reconverted because of a change to the source document, template, or layout only after the time specified by this setting has passed.

  • If a conversion rule is changed to use a different template or layout, the normal evaluation logic is used.

  • If the TimeoutChangedTemplateForcedConversionsInMins is set to a positive value, this setting applies only to changes in the source document.

  • When set to 0, forced or up front conversions will not be reconverted because of a change to the source document.

Default is 15 minutes.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

TimeoutMismatchedForcedConversionsInMins=10

See Also


TraceConversionCacheCleanup

Outputs a report to the debug trace during the Dynamic Converter cache cleanup cycle.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

TraceConversionCacheCleanup=true

See Also


UieHideSearchCheckboxes

Shows or hides the metadata field checkboxes on the search page, which limit the number of metadata fields initially shown on the page.

  • When set to TRUE, the metadata field checkboxes are not shown on the search page.

  • When set to FALSE, the metadata field checkboxes are shown on the search page.

Default is TRUE.

Restart Oracle UCM for this setting to take effect.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

DomainHome/ucm/urm/components/RecordsManagement/records_management_environment.cfg

Example

Used as a configuration entry:

UieHideSearchCheckboxes=true

UseCascadingStyleSheets

Enables the use of cascading style sheets (CSS) for Dynamic Converter.

When set to TRUE, cascading style sheets are enabled.

When set to FALSE, cascading style sheets are disabled. This option is useful only for older browsers that do not support CSS.

Default is TRUE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

UseCascadingStyleSheets=false

VerboseMode

Specifies the level of logging in the Oracle WebCenter Content: Inbound Refinery log.

  • When set to TRUE, the Inbound Refinery log records all messages and configuration information (such as whether the PDF is optimized, where the custom converter path is located, and how much time is allowed for custom conversions).

  • When set to FALSE, the Inbound Refinery log records only error messages.

Default is FALSE.

Type and Usage

Location

  • Local Inbound Refinery Configuration screen, General tab, Verbose logging

  • IntradocDir/IdcRefinery/connections/main/intradoc.cfg

Example

Used as a configuration entry:

VerboseMode=true

WebDAVMaxInactiveInterval

When a user logs in to the Oracle WebCenter Content Server instance through a WebDAV client application, the WebDAV component sets a cookie in the client. The cookie remains set as long as a WebDAV request is made within the time specified by the WebDAVMaxInactiveInterval parameter.

The cookie remains set even if the WebDAV client application is closed. If the cookie expires, the user must log in to the Oracle WebCenter Content Server instance again to perform WebDAV transactions through Microsoft Word, Microsoft Excel, and Microsoft PowerPoint software.

Default is 7200 seconds, or two hours.

Important:

To ensure this setting remains in effect after a software update, perform one of these tasks:
  • Add or edit the setting in the IntradocDir/config/config.cfg file.

  • In the Oracle WebCenter Content Server user interface, select Admin Server, then General Configuration, and enter the setting in the Additional Configuration Variables field.

Type and Usage

Location

IntradocDir/components/Folders_g/folders_environment.cfg

Example

WebDAVMaxInactiveInterval=7200