Skip Headers
Oracle® WebCenter Content Idoc Script Reference Guide
11g Release 1 (11.1.1)

Part Number E10726-03
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

6 Core Oracle WebCenter Content Server Variables and Functions

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


AdditionalIndexBuildParams

Adds build parameters to every indexer execution.

Type and Usage

Parameters

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

AdditionalIndexBuildParams=-repair

AdditionalIndexBuildParams=-optimize maxclean

AdditionalIndexBuildParams=-optimize maxmerge -squeeze

AdditionalSubscriptionCollatedFieldList

Defines a list of additional fields displayed for subscriptions.

The default fields are defined in SubscriptionCollatedFieldList.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

AdditionalSubscriptionCollatedFieldList=dOriginalName

See Also


AdminAtLeastOneGroup

Checks if the current user has the admin role for at least one security group.

Type and Usage

Output

Example

Can be used to do an optional presentation for an administrator:

<$if (AdminAtLeastOneGroup)$>
    <a href="<$redirect$>">
<$endif$>

See Also


AllowCheckin

Checks if the current user has checkin permission for the content item's security group.

Type and Usage

Output

Example

Can be used to do an optional presentation for a user with checkin permission:

<$if (AllowCheckin)$>
    <a href="<$redirect$>">
<$endif$>

AllowCheckout

Checks whether current user has checkout permission for the content item's security group.

Type and Usage

Output

Example

Can be used to do an optional presentation for a user with checkout permission:

<$if (AllowCheckout)$>
    <a href="<$redirect$>">
<$endif$>

AllowAllRedirectUrls

Resets functionality defined by RedirectHostsFilter and causes the Oracle WebCenter Content Server system to act as it did before that variable was set. Setting this variable to TRUE allows the user to be redirected to any URL instead of those specified by RedirectHostsFilter.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

AllowAllRedirectUrls=true

See Also


AllowAlternateMetaFile

Allows users to submit metadata-only content as the alternate file.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

AllowAlternateMetaFile=true

See Also


AllowConcurrentUpdate

Used to allow new documents to be added to the existing collection during a rebuild of the index.

Type and Usage

Location

DomainHome/ucm/cs/bin/intradoc.cfg

Example

Used as a configuration entry:

AllowConcurrentUpdate=TRUE

AllowPrimaryMetaFile

Allows users to submit metadata-only content as the primary file.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

AllowPrimaryMetaFile=true

See Also


AllowReview

Checks if the current user is allowed to approve or reject the current workflow item.

Type and Usage

Output

Example

Displays Approve and Reject buttons if the user is a reviewer:

<$if AllowReview$>
    <$include workflow_doc_action_buttons$>
<$endif$>

AllowSamePrimaryAlternateExtensions

Allows the primary file and alternate file to have the same file extension.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

AllowSamePrimaryAlternateExtensions=true

AppletChunkSize

Sets the size of the transfer chunks for the chunking function, in bytes.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

AppletChunkSize=10000

See Also


AppletChunkThreshold

Sets the minimum file size for the chunking function, in bytes.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

AppletChunkThreshold=500000

See Also


AuthorDelete

Enables authors to delete their own revisions without Delete permission to the security group.

Type and Usage

Location

Example

As a configuration entry:

AuthorDelete=true

As script:

<$if AuthorDelete$>
    <$AuthorDelete$>
<$else$>
    false
<$endif$>

AutoNumberPrefix

Defines the prefix that will be added to all automatically numbered Content IDs.

Type and Usage

Location

Example

As a configuration setting, defines the automatic numbering prefix:

AutoNumberPrefix=HR

As script, returns the value of the configuration setting:

<$AutoNumberPrefix$>

See Also


AutoNumberWidth

Allows you to use more than six digits for a Content ID number, providing support for up to one hundred million content items (eight digits).

Type and Usage

Location

Example

As a configuration setting:

AutoNumberWidth=8

CachedResultRowCount

Sets the size of the search cache.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

CachedResultRowCount=30000

ClearMissingAttributes

Clears custom fields mapped from an LDAP service to Oracle WebCenter Content (WebCenter Content) through JpsUserProvider. This is useful when you have mapped custom fields and then removed values from one or more of those fields. WebCenter Content ignores the missing attributes and continues to use the previous values unless you enable this variable and set it to true.

The default is false.

Type and Usage

Location

Example

Used as a configuration entry. Add the line before the "@end" line in the file. The last lines of the file should look similar to:

SourcePath=jpsuser
ProviderClass=idc.provider.jps.JpsUserProvider
ClearMissingAttributes=true
@end

clearSchemaData

Clears the data from a schema ResultSet.

Type and Usage

Parameters

This function can take zero, one, or two parameters.

Example

<$clearSchemaData()$>

See Also


ColumnMapFile

Specifies the column mapping HTM resource file.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

ColumnMapFile=upper_clmns_map.htm

computeDocUrl

This function computes the URL to a content item based on the data on the page.

For example, this function can be called to generate a URL to an item when looping over a ResultSet of items.

The following information must be present on the page:

Type and Usage

Parameters

The only parameter indicates if the URL is relative, set to TRUE (1) or FALSE (0).


computeRenditionUrl

Returns the URL of a given rendition.

Type and Usage

Parameters

Takes three parameters:

Output

Returns the complete URL of the rendition as a string.

Example

Returns the URL of the rendition as a string.

<$computeRenditionUrl(url, dRevLabel, dRendition1)$>

CONTENT_LENGTH

Retrieves the length in bytes of the requested content item as supplied by the client.

This variable is specific to the current gateway program request.

Important:

This setting is obsolete for the Oracle WebCenter Content Server system version 7.0 and later. The web server filter no longer sends this information.

Type and Usage

Output

Returns the content length in bytes.

Example

As information output on a page or to a log:

CONTENT_LENGTH=0

As part of an Idoc Script statement or evaluation:

<$if CONTENT_LENGTH$>
<!--statement-->

CookieAuthTimeoutInDays

Used with the ExtranetLook component. This variable is used with the CookieLoginPlugin, which monitors web requests and determines if a request is authenticated. It can support authentication based on browser cookies.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

CookieAuthTimeoutInDays=2

See Also


CookieProxyPassword

Used with the ExtranetLook component. This variable is used to encrypt the passwords when users log in to the web site using cookie authentication. It is used with the CookieLoginPlugin, which monitors web requests and determines if a request is authenticated. It can support authentication based on browser cookies. This can be set to any desired value.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

CookieProxyPassword=x2x

See Also


createAlternateMetaFile

Allows users to submit metadata-only content for the alternate file.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

createAlternateMetaFile=true

See Also


createPrimaryMetaFile

Allows users to submit metadata-only content for the primary file.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

createPrimaryMetaFile=true

See Also


DatabasePreserveCase

Defines whether the character case from the database is preserved.

Type and Usage

Location

Example

Used as a configuration entry:

DatabasePreserveCase=false

DatabaseWildcards

Defines the wildcard characters that are used to represent multiple characters in database queries.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DatabaseWildcards=%

Default Accounts

Defines the default accounts for anonymous users.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting, defines default account information:

DefaultAccounts=BOS(R),SEA(RW),MSP/Gen(RWD)

As script, returns the account information as a string:

<$DefaultAccounts$>

See Also


DefaultHtmlRefreshTimeoutInSeconds

Defines the time, in seconds, that a Work In Progress page, My Checked-Out Content page and My Workflow Assignments page refreshes.

In addition to this variable, htmlRefreshTimeout can be set in the URL or the service's databinder. This can be used to set a different refresh time for different pages. If that is needed, do not set DefaultHtmlRefreshTimeoutInSeconds in the config.cfg file, but instead set htmlRefreshTimeout in the URL or databinder.

htmlRefreshUrl can be set to the URL of the page to load after the page is refreshed. The default is the current page. This variable can be set in the URL of the page or the databinder.

The default value for DefaultHtmlRefreshTimeoutInSeconds is 60.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DefaultHtmlRefreshTimeoutInSeconds=120

DefaultPasswordEncoding

Defines the type of encoding to use when storing user passwords.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DefaultPasswordEncoding=OpenText

DisableDBLongIntegerField

In older versions of MSDE software, 4-byte integers were allowed. In newer versions, 8-byte integers and larger are used. This variable allows the Oracle WebCenter Content Server system to continue to use 4-byte integers.

If you upgrade Oracle WebCenter Content Server version 6.2 with MSDE to a newer release, the upgraded instance does not start because of the addition of the dRevRank column. Oracle WebCenter Content Server version 6.2 uses an older MSDE version than later versions. The system will start with the addition of this variable set to TRUE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DisableDBLongIntegerField=true

DisableGzipCompression

Disables gzip compression of HTML pages and log files. Pages are compressed only if the client browser supports compressed HTML. Compression makes pages an average of 80% smaller and is supported by any HTTP 1.1 compatible browser.

Note that output from FILTER_DEBUG is in gzipped format unless this entry is used.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DisableGzipCompression=true

See Also


DisableHttpUploadChunking

Disables the upload chunking function, which is used with the Upload Applet or an HTTP provider.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

DisableHttpUploadChunking=false

See Also


DocTypeSelected

Evaluates whether the Type of the current content item matches the Type in the active ResultSet.

Type and Usage

Output

Example

Returns value based on whether the content item type matches the type for the ResultSet.

<$DocTypeSelected$>

DocUrl

Retrieves the URL of the file in the weblayout directory. This variable is evaluated once per content item, not once per service call.

Type and Usage

Output

Returns the URL of the file as a string.

Example

Used to build URL links to content items.

<$if HasUrl$>
    <a href="<$DocUrl$>"><$dDocName$></a>
<$else$>
    <$dDocName$>
<$endif$>

docUrlAllowDisclosure

Evaluates whether a URL can be disclosed to the current user.

Type and Usage

Parameters

The only parameter is an absolute path, such as the following:

http://mycomputer/domain/groups/.../documents/mydoc.pdf

A full relative path can be used, such as the following:

/oracle/domain/.../documents/mydoc.pdf).

Output

Returns a Boolean value.

Example

Determines if the user can view the URL of the mydoc.pdf document.

<$docUrlAllowDisclosure("/domain/groups/documents/mydoc.pdf")$>

DoDocNameOrder

Sorts content items in the Repository Manager by dDocName. When Repository Manager is started, a default query is run against the database. By default the query results are sorted by the dDocName of the items. Ordering by dDocName makes the order predictable but can result in longer query results.

You can enable the JDBC Query Trace to log information to the console log and verify that the 'order by' clause is no longer part of the query. To enable the JDBC Query Trace, select systemdatabase as an option in the Edit Active Console Output Tracing section of the System Audit Information page.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DoDocNameOrder=false

DomainControllerName

Defines the domain controller to use for NTLM calls.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

DomainControllerName=PDC servername

dWfName

Retrieves the name of the workflow.

Type and Usage

Output

Returns the name of the workflow as a string.

Example

The following code in the IdcHomeDir/resources/core/templates/workflow_info.htm template page is used to display the workflow name on the Workflow Step Information page:

<td align=right><span class=infoLabel><$lc("wwLabelWorkflow")$></span></td>
<td><span class=tableEntry><$dWfName$></span></td>

dWfStepName

Retrieves the name of the current step in the workflow.

Type and Usage

Output

Returns the name of the current step as a string.

Example

The following code in the IdcHomeDir/resources/core/templates/workflow_info.htm template page is used to display the current step name on the Workflow Step Information page:

<td align=right><span class=infoLabel><$lc("wwCurrentStep")$>
</span></td>
<td><span class=tableEntry>
    <$loop WorkflowStep$>
    <$dWfStepName$>
    <$exec RequiredUsers = dWfStepWeight$>
    <$if isTrue(dWfStepIsAll)$><$exec RequiredUsers = 0$><$endif$>
    <$endloop$></span>
</td>

EmptyAccountCheckinAllowed

Checks if an account must be specified on the checkin page.

Used on the Standard Page Resources page to display an error message if an account is not specified.

Type and Usage

Output

Example

Evaluates whether an account number is required and displays an error message.

<$if not EmptyAccountCheckinAllowed$>
    <$isRequired = 1, requiredMsg = "Please specify an account."$>
<$endif$>

EnableDocumentHighlight

Enables highlighting of full-text search terms in PDF, text, and HTML files.

Type and Usage

Location

Example

As a configuration setting:

EnableDocumentHighlight=false

As script, returns the value of the configuration setting:

<$EnableDocumentHighlight$>

See Also


EnableExpirationNotifier

Enables notification of expiration (NOE) of content items. This provides email notification to authors and administrators for documents that will be expired in a short time.

Type and Usage

Location

IntradocDir/config/config.cfg

Parameters

Takes the following optional parameters:

Parameter Description
NotificationQuery Specifies the query to be run to find the expired documents for the notification. The default is the following:
dOutDate > <$dateCurrent()$> <AND> dOutDate < <$dateCurrent(7)$>
NotificationMaximum Specifies the maximum number of documents returned from the query. Default: 1000.
NotifyExtras Denotes the administration users who receive the notification emails. If left blank, no extra notification is sent.
NotifyTime The time of day to send the notification. Default: 00:01. Specified in 24-hour clock notation.
NotificationFieldNames Specifies the field names to include in the notification. Default: dDocAuthor, dOutDate, dDocTitle, dDocName, dDocType, dID, dInDate, dRevLabel, dSecurityGroup
NOEUsePlainTextEmail Allows the use of plain text email for the notification. Default: false. The email template is named QUERY_NOTIFICATION. If NOEUsePlainTextEmail=true, emailFormat=text.
NotificationIntervalInDays Specifies the interval in days. Default: 1.

Example

Used as a configuration entry:

EnableExpirationNotifier=true

EnableSchemaPublish

Enables or disables Schema Publisher.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

EnableSchemaPublish=false

encodeHtml

Idoc function used to filter data input for illegal or corruptive HTML constructs. This function is used by default in Threaded Discussions, a component available during installation.

All input data received by the Oracle WebCenter Content Server system when using the unsafe value for the rule parameter applies only to well-known unsafe script tags. This functionality can be altered by using the HtmlDataInputFilterLevel configuration variable to change the filtering that is done.

Type and Usage

Parameters

Takes two required and one optional parameter:

Output

Returns the encoded string.

See Also


entryCount

Retrieves the number of times the current workflow step has been entered by the current revision.

Type and Usage

Output

Returns the entry count as an integer.

Example

The following code defines a jump called MaxEntry, which exits to the parent workflow and notifies the reviewers if the last time the step was entered was more than one week ago:

<$if wfCurrentGet("entryCount")==2$>
    <$wfSet("WfJumpName","MaxEntry")$>
    <$wfSet("WfJumpTargetStep",wfExit(0,0))$>
    <$wfSet("WfJumpEntryNotifyOff","0")$>
<$endif$>

ExclusiveCheckout

Determines whether users can check out content that was authored by another user.

Type and Usage

Location

Example

As a configuration setting, only original contributor can check out a content item.

ExclusiveCheckout=true

As script, returns the value of the configuration setting:

<$ExclusiveCheckout$>

See Also


ExpireRevisionOnly

Determines if all revisions or only a specific revision of a content item is expired on the specified Expiration Date.

Note:

This variable applies to Oracle WebCenter Content Server version 6.2 and later. Before version 6.2, only the specific revision expired on the specified Expiration Date. Starting with version 6.2, the default behavior is that if the current revision expires, all revisions of that content item also expire. Setting this variable to TRUE returns the system to the pre-6.2 behavior.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

ExpireRevisionOnly=true

fileUrl

Retrieves the relative URL of the current dynamic server page (HCSP or HCST).

This variable is typically used in self-referencing pages, such as a form that posts back to itself.

Type and Usage

Output

Returns the URL as a string.

Example

Returns the relative URL of the current dynamic server page:

<$fileUrl$>

FIRSTREV

Returns the first revision label for the current revision label sequence.

Type and Usage

Output

Returns the first revision label as a string.

Example

Returns the first revision label (default is 1):

<$FIRSTREV$>

ForceDistinctRevLabels

Defines whether additional revisions for the same content item can have the same revision label.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

ForceDistinctRevLabels=true

ForceJdbcSync

Restricts access to the database to one query at a time.

This setting is typically used for debugging or for problematic JDBC drivers.

If the system is being used mostly for read-only type activity, setting this to FALSE will improve the throughput to the database.

When set to TRUE, one query at a time can access the database.

When set to FALSE, multiple queries can access the database at a time.

Default setting is FALSE. (Default for version 4.5 and earlier was TRUE.)

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

ForceJdbcSync=true

formatDateDatabase

Formats the date and time in preparation for an SQL query. Long-formatted dates cannot be evaluated (for example, May 22, 2000).

Type and Usage

Parameters

The only parameter is a string or variable that specifies a date/time.

Output

Example

Formats the current date and time for an SQL query:

<$formatDateDatabase(dateCurrent())$>

Formats the date and time and displays as 2001-03-19 15:32:00:

<$formatDateDatabase("03/19/2001 3:32 PM")$>

Formats the date and time and displays as 1999-04-03 00:00:00:

<$formatDateDatabase("4/3/99")$>

FormInheritMetaDataFieldList

Defines the custom metadata fields that are inherited by subsequent revisions of a PDF form.

This is a comma-delimited list.

Standard metadata fields (such as Type, Security Group, and Account) are inherited by default.

Custom metadata fields begin with a lowercase x (for example, xComments).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

FormInheritMetaDataFieldList=xDepartment,xRegion

GATEWAY_INTERFACE

Retrieves the revision level of the CGI specification to which this server complies. This variable is not request-specific; it is set for all requests.

Type and Usage

Output

Returns the revision level as a string in the format CGI/revision.

Example

As information output on a page or to a log:

GATEWAY_INTERFACE=CGI/1.1

As part of an Idoc Script statement or evaluation:

<$if GATEWAY_INTERFACE$>
<!--statement-->

getCookie

Obtains a cookie from a browser.

This is useful for tracking user sessions when the information does not need to be stored in the personalization.

Can be used to track the last pages navigated to, or the last searches which were run.

Type and Usage

Parameters

This function takes one parameter, the name of the cookie.

Example

<$myCounter=getCookie("myCounter")$>
<$if not myCounter$>
    <$myCounter=1$>
<$endif$>
Num times loaded: <$myCounter$>
<$setCookie("myCounter", myCounter+1, dateCurrent(1))$>

See Also


GetCopyAccess

Determines what permission a user must have to get a copy of a content item.

When set to TRUE, users can get a copy of a content item for which they have only Read permission.

When set to FALSE, users must have Write permission to a content item to be able to get a copy.

Default is FALSE.

Type and Usage

Location

Example

As a configuration setting:

GetCopyAccess=true

As script, returns the value of the configuration setting:

<$GetCopyAccess$>

getFieldConfigValue

This function returns a configuration flag for a specific field. If the field does not exist, the default is returned instead.

Type and Usage

Parameters

Takes three parameters:

Output

Returns the specified configuration flag.

Example

<$caption = getFieldConfigValue("dDocTitle", "fieldCaption", lc("wwTitle"))$>

getFieldViewDisplayValue

Returns the display value for an item in a Schema option list.

For example, assume an option list exists for a custom metadata field named Customer. In the database there is a schema table with the CustomerName and a unique CustomerID. On checkin the CustomerName is visible to the user but the CustomerID is what is stored in the database. The getFieldViewDisplayValue function extracts the human-readable CustomerName based on the CustomerID.

Type and Usage

Parameters

Takes three parameters:

Output

Returns the display value.

Example

<$customerName = getFieldViewDisplayValue("xCustomer", "Customer_View", "1234")$>

getParentValue

This function returns a parent value from a Schema view. This is needed before generating the dependent option list for the current field.

In most cases this function returns the same value as the internal parent value parameter because most option lists trigger their dependency on the unique key for the parent field. However, this is not a requirement for complex dependent choice lists.

Type and Usage

Parameters

Takes four parameters:

Example

<$parentValue=getParentValue("xState", "Country_State", "xCountry", "123")$>

getViewValue

Returns the display value for an item in a Schema option list.

For example, assume an option list exists for a custom metadata field named Customer. In the database there is a schema table with the CustomerName and a unique CustomerID. On checkin the CustomerName is visible to the user but the CustomerID is what is stored in the database. The getFieldViewDisplayValue function extracts the human-readable CustomerName based on the CustomerID.

Type and Usage

Parameters

Takes three parameters:

Output

Returns the display value.

Example

<$custName = getViewValue("Customer_View", "1234", "CustomerName")$>
<$custRegion = getViewValue("Customer_View", "1234", "CustomerRegion")$>

See Also


getViewValueResultSet

This function loads a schema table and places it on the page as a ResultSet named SchemaData. The column names in the ResultSet are the same as the names in the database table.

This function is most useful to obtain a list of dependent choices based on a parent value.

Type and Usage

Parameters

Takes three parameters:

Example

Assume you have a schema table and view for a list of countries. The view is named Country_view..

To output the contents of that table to the page, use the following code.

<$getViewValuesResultSet("Country_View", "", "")$>
<$loop SchemaData$>
<$count = 0, num = rsNumFields("SchemaData")$>
    <$loopwhile count < num$>
        <$fieldName=rsFieldByIndex("SchemaData", count)$>
        <$fieldName$> = <$getValue("SchemaData", fieldName)$>
        <$count = count + 1$>
    <$endloop$>
<$endloop$>

This will output the table even if you do not know the column name.

In the following example, assume you have a DCL for the fields Country and State. The list of States depends on which Country is selected. To obtain the list of States when the Country is USA, use this code:

<$getViewValuesResultSet("State_View", "Country_State", "USA")$>

hasAppRights

Checks if the current user has rights to an administrative application.

Type and Usage

Parameters

The only parameter is one of the following administrative applications:

Output

Example

Evaluates whether the current user has rights to the specified application.

<$hasAppRights('RepoMan')$>

HasExternalUsers

Indicates to the Oracle WebCenter Content Server system that an external user database is present.

When set to TRUE, the system recognizes external users. If a custom component has been written to support an external user integration (such as LDAP), this should be set to TRUE.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

HasExternalUsers=true

As script, returns the value of the configuration setting:

<$HasExternalUsers$>

See Also


HasOriginal

Checks if an original file exists for a revision.

This variable checks for a dOriginalName value.

It is possible for a content item to be checked in but to not have an original file (for example, when a Basic workflow has been started but files have not been checked in at the initial contribution step).

Type and Usage

Output

Example

Checks for an original file:

<$if HasOriginal and not isNew$>

HasPredefinedAccounts

Checks if the current user has permission to any predefined accounts. Predefined accounts are those that are created in the User Admin utility.

Type and Usage

Output

Example

Displays the Accounts option list if the user is assigned to any predefined accounts:

<$if HasPredefinedAccounts$>
    <$fieldIsOptionList = 1, optionListName = "docAccounts",     fieldOptionListType = "combo"$>
<$endif$>

HasUrl

Checks if a file exists in the weblayout directory for the current content item.

Type and Usage

Output

Example

Checks for a web layout file:

<$if HasUrl$>
    <$include doc_url_field$>
<$endif$>

HtmlDataInputFilterLevel

A configuration entry used in conjunction with encodeHtml. This entry applies a level of encoding to filter all input to the system for bad HTML constructions.

All input data received by the system when using the unsafe value for the encodeHtml rule parameter applies only to well-known unsafe script tags. This functionality can be altered by using the HtmlDataInputFilterLevel configuration variable to change the filtering that is done.

Type and Usage

Parameters

This entry takes one parameter, the filter level. Accepted values are:

Location

IntradocDir/config/config.cfg

See Also


HTTP_ACCEPT

Retrieves a list of content types that the browser can accept.

Type and Usage

Output

Returns a list of content types as a comma-delimited string.

Example

As information output on a page or to a log:

HTTP_ACCEPT=text/xml,application/xml,application/xhtml+xml,text/html;
q=0.9,text/plain;q=0.8,video/x-mng,image/png,image/jpeg,image/gif;
q=0.2,text/css,*/*;q=0.1

As part of an Idoc Script statement or evaluation:

<$if HTTP_ACCEPT$>
<!--statement-->

HTTP_ACCEPT_ENCODING

Retrieves a list of compression encodings that the browser supports.

As of Oracle WebCenter Content Server version 7.0, HTML files are compressed for delivery. GZIP compression is the default.

Type and Usage

Output

Returns a list of compression encodings as a comma-delimited string.

Example

As information output on a page or to a log:

HTTP_ACCEPT_ENCODING=gzip, deflate, compress;q=0.9

As part of an Idoc Script statement or evaluation:

<$if HTTP_ACCEPT_ENCODING$>
<!--statement-->

HTTP_ACCEPT_LANGUAGE

Retrieves a list of ISO languages that are set for the browser.

This variable might be useful for estimating which user locale to set for new or guest users.

Type and Usage

Output

Returns a list of languages as a comma-delimited string.

Example

As information output on a page or to a log:

HTTP_ACCEPT_LANGUAGE=en-us,en;q=0.50

As part of an Idoc Script statement or evaluation:

<$if HTTP_ACCEPT_LANGUAGE$>
<!--statement-->

HTTP_COOKIE

Retrieves the name/value pair of the cookie in the HTTP request header.

Type and Usage

Output

Returns a string in the format name1=string1; name2=string2.

Example

As information output on a page or to a log:

HTTP_COOKIE=IntradocAuth=Basic; IntrdocLoginState=1

As part of an Idoc Script statement or evaluation:

<$if HTTP_COOKIE$>
<!--statement-->

HTTP_HOST

Retrieves the name of the web server.

Type and Usage

Output

Returns the web server name as a string.

Example

As information output on a page or to a log:

HTTP_HOST=centralserver

As part of an Idoc Script statement or evaluation:

<$if HTTP_HOST$>
<!--statement-->

HTTP_INTERNETUSER

Retrieves the CGI parameter that the web server security filter passes to the system so that the system can set the user.

If this variable is not set, the value of the REMOTE_USER variable is used.

If HTTP_INTERNETUSER and REMOTE_USER variables are not set, the user is anonymous.

Type and Usage

Output

Returns the user name as a string.

Example

As information output on a page or to a log:

HTTP_INTERNETUSER=admin

As part of an Idoc Script statement or evaluation:

<$if HTTP_INTERNETUSER$>
<!--statement-->

HTTP_REFERER

Retrieves the complete URL of the referenced directory on the local server.

Type and Usage

Output

Returns the complete URL as a string.

Example

As information output on a page or to a log:

HTTP_REFERER=http://centralserver/domain/

As part of an Idoc Script statement or evaluation:

<$if HTTP_REFERER$>
<!--statement-->

HTTP_USER_AGENT

Retrieves the client browser type, version number, library, and platform the browser is configured for.

Type and Usage

Output

Returns a string in the format software/version (library) (platform).

Example

As information output on a page or to a log:

HTTP_USER_AGENT=Mozilla/4.7 [en] (WinNT; U)

As part of an Idoc Script statement or evaluation:

<$if HTTP_USER_AGENT$>
<!--statement-->

HttpIgnoreWebServerInternalPortNumber

When set to TRUE, causes the HTTP address computed for the Admin Server and applets to not use the server port value provided by the web server.

This prevents a load balancing configuration problem in which the load balancing server is using a different port number than the internal web server actually delivering the response to the request.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

HttpIgnoreWebServerInternalPortNumber=true

See Also


IDC_Name

Defines the unique name of the Oracle WebCenter Content Server instance.

Caution:

Using duplicate IDC_Name settings will cause data corruption. The Archiver cannot be used to move or copy data between two instances that share the same IDC_Name setting. To do so will corrupt the data on the target system. Give each of your instances a unique IDC_Name setting.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IDC_Name=OracleMSP

See Also


IdcAuthExtraRequestParams

Specifies values for the web server plug-in to get from its local data and send in the header of its requests.

For example, if you have a plug-in to the web server filter getting some attributes for a user and placing them into a local value, you could specify the name of the attributes in IdcAuthExtraRequestParams, and the data would be passed to the Oracle WebCenter Content Server instance.

This setting can also be used to access extra HTTP header values using Idoc Script. These variables will become part of the Data Binder environment variable set.

There is no default value.

For information about IdcCommand, see Oracle WebCenter Content Developer's Guide for Content Server.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

The following setting tells the IIS web server plug-in to send the local value of HTTP_REFERER in the header (IIS automatically adds the HTTP_ prefix):

IdcAuthExtraRequestParams=referer

IdcCommandFile

Specifies a file containing commands to execute using IdcCommand.

There is no default setting.

For information about IdcCommand, see Oracle WebCenter Content Developer's Guide for Content Server.

Type and Usage

Location

DomainHome/ucm/cs/bin/intradoc.cfg

Example

Used as a configuration entry:

IdcCommandFile=c:/ucm/idc/add_user.txt

IdcCommandLog

Specifies the path to the log file for IdcCommand execution.

The log file contains the time the command was executed and the success or failure status of the command.

There is no default setting.

For information about IdcCommand, see Oracle WebCenter Content Developer's Guide for Content Server.

Type and Usage

Location

DomainHome/ucm/cs/bin/intradoc.cfg

Example

Used as a configuration entry:

IdcCommandLog=c:/idc/idccommand.log

IdcCommandServerHost

Specifies the web server address of the Oracle WebCenter Content Server instance to which IdcCommand is connecting.

Default is the HttpServerAddress of the Oracle WebCenter Content Server instance to which IdcCommand is connecting.

For information about IdcCommand, see Oracle WebCenter Content Developer's Guide for Content Server.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IdcCommandServerHost=instance_name.example.com

See Also


IdcCommandUser

Specifies the user that is permitted to execute commands using IdcCommand.

For information about IdcCommand, see Oracle WebCenter Content Developer's Guide for Content Server.

There is no default setting.

Type and Usage

Location

DomainHome/ucm/cs/bin/intradoc.cfg

Example

Used as a configuration entry:

IdcCommandUser=sysadmin

IdcHttpHeaderVariables

Defines data parameters to include in HTTP header responses.

This is a comma-delimited list.

The format for encoding the name value pairs is the typical hda format after applying the Oracle WebCenter Content Server HTTP header encoding.

The values are UTF-8 encoded and special characters are %xx encoded.

This setting is specifically designed for web server plug-ins that want to audit the requests made by the client. The plug-ins can examine the HTTP headers in the responses, but not the body of the content. By pushing some of the parameters of the request into an HTTP header response, a plug-in can audit which documents were accessed and what actions were performed on them.

The name of the HTTP header generated by the Oracle WebCenter Content Server instance when sending a response to an HTTP-based client is IdcVariables.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

If IdcHttpHeaderVariables=IdcService,dDocName, then prior to the UTF-8 encoding being applied, the header value might be:

@Properties LocalData
IdcService=GET_DOC_PAGE
dDocName=TestDoc
blDateFormat=M/d{/yy}{ h:mm[:ss]{ a}}!mAM,PM!tAmerica/New_York
blFieldTypes=
@end

The UTF-8 encoding would leave all the above characters alone, except that it would change every line feed character into the %0A characters. The blDateFormat is the system date format for the Oracle WebCenter Content Server instance.


IndexableRenditions

A comma-delimited list of single character codes for renditions to be indexed other than the primary, alternate, or web-viewable renditons. Typically only one letter will be used because only one rendition will be indexable (such as the XML rendition).

This is used in conjunction with IsAllowIndexRenditions.

Type and Usage

Location

IntradocDir/config/config.cfg

See Also


IndexerAutoWorkInterval

Defines the interval in seconds at which the Indexer automatic update cycle checks for changes.

Default is 300 (5 minutes).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IndexerAutoWorkInterval=600

IndexerLargeFileSize

Determines the file size in megabytes at which the Indexer will place the file in its own bulkload (batch) file.

Files larger than this setting are indexed in a separate bulkload. Files smaller than this setting will be indexed in a batch with other files.

Default is 1 megabyte.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IndexerLargeFileSize=2

IndexerRebuildStagingManualCopy

Enables an index rebuild to create the collection in another location.

This variable is typically used when rebuilding extremely large collections. When the rebuild is finished, the results can be merged back to the collection manually.

When set to TRUE, the rebuilt index is created in the location set by the IndexerRebuildStagingPath value.

When set to FALSE, the rebuilt index is created in the next active index directory.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IndexerRebuildStagingManualCopy=true

See Also


IndexerRebuildStagingPath

Defines the path where an Indexer rebuild will be created.

This variable is typically used when rebuilding extremely large collections. When the rebuild is finished, the results can be merged back to the collection manually.

There is no default value.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IndexerRebuildStagingPath=c:/buildX/

See Also


indexerSetCollectionValue

This function modifies the logic of the search indexer. This function is designed to allow calculation of cumulative statistics about the index collection.

Type and Usage

Parameters

Takes two parameters:

Any name and value can be used. These values become available the next time the resource include is executed for the index collection.


IndexerTouchMonitorInterval

Defines the time that the Oracle WebCenter Content Server system waits before it will treat an Indexer lock file whose timestamp has not changed as having expired. The system will also touch any locks it is maintaining twice during this interval.

An Indexer lock is created by placing a lock file into an appropriate directory. In order for the lock to persist, the timestamp on the file must change periodically. Otherwise the Oracle WebCenter Content Server system will treat the lock as an expired lock.

The smaller the value of this setting, the quicker that locks can alternate between Indexing cycles. The larger the value, the more likely that high activity (which could keep a touch request delayed for many seconds) will cause the Oracle WebCenter Content Server system to falsely report a lock as having expired. If a lock is falsely expired, it can cause duplicated effort (although it should not have any long term impact on the state of the Oracle WebCenter Content Server system).

Default is 12000 milliseconds (12 seconds).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

IndexerTouchMonitorInterval=15000

See Also


IndexerTraceCycleListChanges

Dumps trace information to the console for changes to the list of active indexing cycles maintained by the Oracle WebCenter Content Server system.

At certain points in an indexing cycle, an exclusive lock is required, so indexing cycles may have to wait for other cycles to become inactive. Enabling this setting can help you audit the performance of the Indexer.

When set to TRUE, changes to the indexing cycle list are output to the console.

When set to FALSE, changes to the indexing cycle list are not output.

Default is FALSE.

Note:

This variable is obsolete as of Oracle WebCenter Content Server version 7.0. Functionality is now available on the System Audit Information page.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IndexerTraceCycleListChanges=true

See Also


IndexerTraceLockFileChanges

Dumps trace information to the console for changes the Oracle WebCenter Content Server system makes to the Indexer lock and suspension files.

When set to TRUE, changes to the files are output to the Oracle WebCenter Content Server console.

When set to FALSE, changes to the files are not output.

Default is FALSE.

Note:

This variable is obsolete as of Oracle WebCenter Content Server version 7.0. Functionality is now available on the System Audit Information page.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IndexerTraceLockFileChanges=true

See Also


IndexerTraceStartStop

When set to TRUE, traces the starting and stopping of index cycles.

Default is FALSE.

Note:

This variable is obsolete as of Oracle WebCenter Content Server version 7.0. Functionality is now available on the System Audit Information page.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IndexerTraceStartStop=true

See Also


InstanceDescription

Defines a description for the instance.

The instance description is used in the Oracle WebCenter Content Server interface.

Type and Usage

Location

Example

As a configuration entry:

InstanceDescription=Master_on_Server1

As script, returns the server instance description as a string:

<$InstanceDescription$>

See Also


InstanceMenuLabel

Defines the label for the instance that is used in the Windows Start menu.

There is no default value.

Type and Usage

Location

System Properties, Server tab, Instance Menu Label

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

InstanceMenuLabel=Master_on_Server1

See Also


IntradocRealm

Defines the realm used when the Oracle WebCenter Content Server instance or the web server plug-in challenges for Basic authentication.

In browsers, the realm is usually called a resource when it is displayed in the login dialog.

NTLM does not use a realm; authentication is always against the entire Microsoft network.

Default is IDC Security.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IntradocRealm=main

See Also


IntradocServerHostName

Defines the host name to use when opening a socket connection to the Oracle WebCenter Content Server instance.

This setting is used by the CGI code that translates calls from the web server to requests to the Server.

Default value is localhost.

To call services remotely, IntradocServerHostName must be set to IP or DNS.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IntradocServerHostName=IP

See Also


IntradocServerPort

Defines the port that the web server filter or any other application should use to talk to the Oracle WebCenter Content Server instance.

This setting tells the CGI code that translates from a call to the web server to a request to the Oracle WebCenter Content Server instance to use this port when talking to the Oracle WebCenter Content Server system. The CGI code will pick up this value automatically if the web server is stopped and started after the Oracle WebCenter Content Server instance has been stopped and started.

In IIS, the CGI code is implemented by the iis_idc_cgi.dll ISAPI extension.

Default is 4444.

To call services remotely, the server port must be defined.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IntradocServerPort=5550

IsAllowIndexRenditions

If set to TRUE, allows extra renditions of a document. This is only used if there are no indexable vault renditions or web-viewable renditions.

The accepted rendition types are listed in IndexableRenditions.

Type and Usage

Location

IntradocDir/config/config.cfg

See Also


IsAutoNumber

Enables automatic numbering of Content IDs.

When set to TRUE, a Content ID (dDocName) is automatically assigned to each new content item upon checkin.

When set to FALSE, the user must specify a Content ID for each new content item.

Default is FALSE.

Type and Usage

Location

Example

Used as a configuration entry:

IsAutoNumber=true

See Also


IsAutoSearch

Enables automatic indexing and archive export.

When set to TRUE, the Oracle WebCenter Content Server system automatically indexes content items or automatically export documents to an archive.

When set to FALSE, the system does not automatically index content items or automatically export documents to an archive.

The NoAutomation setting overrides this setting.

Default is TRUE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IsAutoSearch=true

See Also


IsCheckinPreAuthed

Checks if a checkin application pre-authorized the current checkin by getting a security token.

Type and Usage

Output

Example

Checks for checkin pre-authorization:

<$IsCheckinPreAuthed$>

isComponentEnabled

Checks if the defined component in enabled.

Type and Usage

Parameters

The only parameter is the component name.

Output

Example

<$isComponentEnabled("Folders")$>

IsContributor

Used to evaluate whether a user is a contributor. Generally used to determine whether to show special links on a page (for example, std_page uses it to decide whether to display the Content Manager link).

Type and Usage

Output

Example

Used to evaluate whether a user is a contributor:

<$if IsContributor$>

IsCriteriaSubscription

Evaluates whether a subscription to the content item is criteria-based rather than based on the Content ID (dDocName).

Type and Usage

Output

Example

Evaluates whether subscription is criteria based:

<$IsCriteriaSubscription$>

IsEditRev

Checks whether the current revision is in an Editor step in a workflow.

When set to TRUE, reviewers can check out, edit, and check in the revision.

This variable is set by defining a workflow step as an Editor step in the Workflow Admin tool. This variable is evaluated on the checkin page.

Type and Usage

Output

Example

Provides workflow details:

<$if IsEditRev$>
    addCheckinValue("IdcService", "WORKFLOW_CHECKIN");
if (form.isFinished.checked)
    addCheckinValue("isFinished", form.isFinished.value);
<$else$>
    addCheckinValue("IdcService", "CHECKIN_SEL");
<$endif$>

IsFailedIndex

Checks if the Indexer has failed to index the content item.

Type and Usage

Output

Example

Displays text if the content item was not indexed:

<$if IsFailedIndex $>
    <p><font face="arial" size="2">
    Unable to index content item.</p>
<$endif$>

IsFilePresent

Checks if the page currently being displayed is for the revision being looped over while building the Revision History table on a content information page.

Type and Usage

Output

Example

If the loop is at the current revision, the revision number is displayed as plain text. If the loop is not at the current revision, the revision number is displayed as an active button.

<@dynamichtml doc_rev_info@>
<$if IsFilePresent$>
  <td width=10% align=center><span class=strongHighlight><$dRevLabel$></span></td>
  <td nowrap width=30%><span class=strongHighlight><$dInDate$></span></td>
  <td nowrap width=30%><span class=strongHighlight>
    <$if dOutDate$><$dOutDate$><$else$><$lc("wwNone")$><$endif$></span></td>
      <td width=20%><span class=strongHighlight>
      <$rptDisplayMapValue("StatusList", dStatus)$></span></td>
    <$else$>
  <td width=10%><form action="<$HttpCgiPath$>" method=GET>
  <input type=hidden name=IdcService value="DOC_INFO">
  <input type=hidden name=dID value="<$dID$>">
  <input type=hidden name=dDocName value="<$dDocName$>">
  <input type=submit value="       <$dRevLabel$>      ">
  </form></td>
...
<@end@>

IsFormsPresent

Specifies if the PDF Forms software is installed.

This value is set to FALSE during initial installation.

This value is set to TRUE during PDF Forms installation.

Note:

This variable is deprecated. Use IsContentRefineryPresent instead.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IsFormsPresent=false

See Also


IsFullTextIndexed

Checks if the Indexer has full-text indexed the content item.

Type and Usage

Output

Example

Provides a specified URL if the content item is full-text indexed:

<$if IsFullTextIndexed$>
    <a href="<$redirect$>">
<$endif$>

IsJdbcLockTrace

Dumps trace information to the console for database lock activity.

Used only with SQL Server and Oracle databases.

On Solaris, this output also appears in a log file in the IntradocDir/etc/log directory.

Default is an empty string.

This variable is obsolete as of the 7.0 release of the Oracle WebCenter Content Server system. The functionality is available on the System Audit Information page.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IsJdbcLockTrace=true

See Also


IsJdbcQueryTrace

Dumps trace information to the console for database query activity.

Used only with SQL Server and Oracle databases.

On Solaris, this output also appears in a log file in the IntradocDir/etc/log directory.

Default is an empty string.

This variable is obsolete as of the 7.0 release of the Oracle WebCenter Content Server system. The functionality is available on the System Audit Information page.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

IsJdbcQueryTrace=true

See Also


isLayoutEnabled

Used to determine if a particular layout is installed and enabled.

Type and Usage

Parameters

Takes one parameter, the ID of the layout.

Example

In the std_resources.htm file:

<$if isLayoutEnabled("Trays")$><$do Publish=1$><$endif$>

IsLocalSearchCollectionID

Checks if the content item is in the local search collection. Searches for the content item's Content ID in the local search collection.

Type and Usage

Output

Example

Evaluates whether a content item is from a local collection:

<@dynamichtml searchapi_define_result_doc_parameters@>
<$exec IsLocalSearchCollection="1"$>
<$if not IsLocalSearchCollectionID$>
    <!--Collection has external ID-->
<$exec IsLocalSearchCollection=""$>

IsLoggedIn

Checks if the current user is logged in.

Type and Usage

Output

Example

Checks whether the user is logged in and has an e-mail address before performing a function.

<@dynamichtml subscription_action_script@>
function allowSubscription(form)
    {<$if IsLoggedIn$>
    <$if IsUserEmailPresent$>
    <$else$>
…}
<@end@>

IsNotLatestRev

Checks if the revision is the last revision to be checked in. This is not necessarily the last released revision.

Type and Usage

Output

Example

Checks for the latest revision:

<$IsNotLatestRev$>

See Also


IsNotSyncRev

Checks whether the file on the client computer matches the most current revision by performing a revision ID (dID) comparison.

This variable is generally used to display an error message when the local copy of a content item has not been updated to the latest revision.

This variable is used to interface with client-side products, such as Desktop.

Type and Usage

Output

Example

Checks for a match with the latest revision and displays an error message:

<$if IsNotSyncRev$>
The local copy of this content item has not been updated to the latest revision. 
    Use Get Native File or Check Out to update your local copy of <$dDocName$>.
<$endif$>

IsPrimaryUserBase

Specifies whether the LDAP provider is the primary LDAP server where external users are defined.

When set to TRUE, the provider will be used to authenticate new LDAP users who have not previously logged in to the Oracle WebCenter Content Server instance.

When set to FALSE, the provider will be used to authenticate only LDAP users who have previously logged in using credentials from that provider.

Default is TRUE.

This setting is obsolete for version 7.0 and later of the Oracle WebCenter Content Server system. See Priority for information on setting the order in which LDAP providers will be checked.

Type and Usage

Location

Example

Used as a configuration entry:

IsPrimaryUserBase=false

IsPromptingForLogin

Checks if the Oracle WebCenter Content Server instance is set to prompt for login or if login is being handled programmatically.

This variable is set to TRUE in situations such as cookie login pages, where the last request failed because the user is not logged in yet.

Type and Usage

Output

Example

Evaluates if server is set to prompt for login:

<$IsPromptingForLogin$>

isRepromptLogin

This workflow configuration entry is a suffix appended to a workflow step, forcing a new authentication challenge.

When set to TRUE, this configuration variable forces a login at a specific step of a workflow. This acts as a digital signature for that step.

This variable can be added at multiple steps of a workflow.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

In the following example, a review step named VPApproval requires a digital signature before continuing in the workflow. Set the isRepromoptLogin configuration entry as follows before initiating the workflow:

VPApproval:isRepromptLogin=true

See Also


IsSavedWfCompanionFile

Saves a copy of the companion file that is created when a piece of content enters a workflow. Normally the companion file is deleted when the content is approved and exits the workflow.

To use this variable, insert the variable as shown into the config.cfg file and restart the Oracle WebCenter Content Server instance. The file will be saved in the IntradocDir/data/workflow/saved directory.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration variable:

IsSaveWfCompanionFiles=true

IsSubAdmin

Checks if the current user has subadministrator rights to at least one administrative application.

Type and Usage

Output

Example

Checks whether the user is logged in and has subadministrator rights before performing a function.

<@dynamichtml subscription_action_script@>
    function allowSubscription(form)
    {
    <$if IsLoggedIn$>
    <$if IsSubAdmin$>
    <$else$>
    …
    }
<@end@>

IsSysManager

Checks if the current user has the sysmanager role, meaning the user has access to the Admin Server. This variable is usually used to conditionally display specific navigation links.

Type and Usage

Output


IsUploadSockets

Used by the Upload applet to determine whether the upload socket should be used.

This is an internal flag and is not intended for user configuration.

Type and Usage

Output

Example

N/A


isUserOverrideSet

Enables users to check in content for other users.

This affects the Author option list on checkin pages. By default, only administrators are allowed to specify another user as the Author during checkin.

Type and Usage

Parameters

The only parameter is the value TRUE or FALSE.

Output

Evaluates to TRUE if the user override is enabled.

Example

Enables users to check in content items with another user specified as the Author:

<$isUserOverrideSet(true)$>

See Also


isValidateFile

Used as a parameter to the Upload applet. This variable verifies that the file to be uploaded exists. In order to be used, a component must be created that overwrites the applet definition as defined in the std_multiupload_applet_definition include in the std_page.htm resource file.

Type and Usage

Example

Used as a configuration entry:

isValidateFile=true

IsWebServerPagesOnly

Used with the ExtranetLook component. This variable determines if cookie-based authentication is used or not. See the Oracle WebCenter Content System Administrator's Guide for Content Server for details about using the ExtranetLook functionality.

When IsWebServerPagesOnly is set to TRUE, basic authentication is used and cookie-based logon/logoff functionality is disabled. Customized versions of the web server filter are used.

If set to FALSE, cookie-based authentication is used.

Type and Usage

Location

Example

IsWebServerPagesOnly=FALSE

See Also


IsWorkflow

Checks if the content item on a checkin page is in a workflow.

Type and Usage

Output


isZoneSearchField

This function is used to specify a field for full text searching.

Type and Usage

Parameters

The name of the field to be checked.


JdbcConnectionString

Defines the Java Database Connectivity (JDBC) connection (SQL Server Data Source Name), including the hostname, port number, and instance name.

This setting is automatically configured during installation if there are no network errors that make it impossible for the system to connect to the database. This setting must be changed manually if the database is changed or if the system could not find the database during installation.

If the run time version of Microsoft Access or MSDE is used, there are no database configuration options to set.

Default is JdbcConnectionString=JDBC:ODBC:SQLForInstance_name.

Type and Usage

Location

Example

Defines the JDBC connection path:

JdbcConnectionString=jdbc:oracle:thin:@hostname:port_number:instance_name

See Also


JdbcDriver

Defines the Java Database Connectivity (JDBC) device driver name.

This setting is automatically configured during installation if there are no network errors that make it impossible for the system to connect to the database. This setting must be manually changed if the database is changed or if the system could not find the database during the installation.

If the run time version of Microsoft Access or MSDE is used, there are no database configuration options to set.

There is no default value.

Type and Usage

Location

Example

Defines the JDBC device driver:

JdbcDriver=oracle.jdbc.driver.OracleDriver

See Also


JdbcPassword

Defines the SQL Server database password.

There is no default value.

Type and Usage

Location

Example

Used as a configuration entry:

JdbcPassword=password

See Also


JdbcPasswordEncoding

Defines the type of encoding to use when storing the SQL Server database password.

To disable password encryption, set this value to ClearText.

Default is Intradoc.

If any other nonempty value is assigned, no encoding is performed.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

JdbcPasswordEncoding=ClearText

JdbcUser

Defines the SQL Server database user name.

Default is sa.

Type and Usage

Location

Example

Used as a configuration entry:

JdbcUser=sa

See Also


jsFilename

Used by schema. Encodes a string that may contain non-ASCII characters into the valid filename strings required for the operating system and Java Script (performs an encoding function).

Type and Usage

Parameters

The only parameter is the string to be encoded.

Output

Returns an encoded string.

Example

<$jsFilename(fileName)$>

lastEntryTs

Retrieves the timestamp from the last time the workflow step was entered.

This variable can be used to create conditional statements, but it should not be hard-coded or altered.

The last entry time is localized in the companion file and maintained in the key:

<step_name>@<workflow_name>.lastEntryTs

Type and Usage

Output

Returns the timestamp in the format defined by dateCurrent.

Example

The following code defines a jump called LastEntry, which exits to the parent workflow and notifies the reviewers if the last time the step was entered was more than one week ago:

<$if parseDate(wfCurrentGet("lastEntryTs")) < parseDate(dateCurrent(-7))$>
    <$wfSet("WfJumpName","LastEntry")$>
    <$wfSet("WfJumpTargetStep",wfExit(0,0))$>
    <$wfSet("WfJumpEntryNotifyOff","0")$>
<$endif$>

LdapAdminDN

Specifies a user name that has Read permission for the LDAP server.

If this setting is not defined, the provider will connect to the LDAP server anonymously.

If the LDAP provider is communicating with Active Directory, a user name and password is required, and must be a valid domain user in the format DOMAIN\username.

Type and Usage

Location

Example

Used as a configuration entry:

LdapAdminDN=ldap_admin

See Also


LdapAdminPassword

Specifies the password for the LdapAdminDN setting, which specifies a user name that has Read permission for the LDAP server.

Type and Usage

Location

Example

Used as a configuration entry:

LdapAdminPassword=idc2

See Also


LdapPort

Defines the port number the LDAP server listens on.

Default is 389, unless you are using SSL.

If you are using SSL (see UseSecureLdap), set this value to 636.

Type and Usage

Location

Example

Used as a configuration entry:

LdapPort=636

See Also


LdapServer

Host name of the LDAP server.

If the provider is communicating with Active Directory, this should be the host name of a primary domain controller.

Type and Usage

Location

Example

Used as a configuration entry:

LDAPServer=iplanet_dir

LdapSuffix

Specifies the root suffix (naming context) to use for all LDAP operations (such as o=example.com or dc=example,dc=com).

All mapping of LDAP groups to Oracle WebCenter Content Server roles and accounts will begin at this root.

Do not include spaces before or after commas.

Type and Usage

Location

Example

Used as a configuration entry:

LdapSuffix=dc=example,dc=com

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, links are extracted.

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 must 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 disregards during the link extraction process. By default, this is empty.

There are some file formats (such as Word) that need to 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 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 must 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 multiple errors 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


LmDefaultLayout

Defines the default layout to use (for example, Top Menus or Trays).

The default installation value is Trays.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

LmDefaultLayout=Top Menus

LmDefaultSkin

Defines the default skin to use (for example, Oracle, Oracle2).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

LmDefaultSkin=Oracle

lmGetLayout

Retrieves the layout selected by the user (for example, Top Menus or Trays).

Type and Usage

Parameters

None.

Example

<$lmGetLayout()$>

See Also


lmGetSkin

Retrieves the skin selected by the user.

Type and Usage

Parameters

None.

Example

<$lmGetSkin()$>

See Also


loadCollectionInfo

Loads metadata for a search collection.

Used by the search service to load metadata about a search collection.

This function is not intended for user configuration.

Type and Usage

Parameters

Takes one parameter, the name of the search collection to be loaded.

Output

None.

Example

Loads search collection information:

<$loadCollectionInfo(collection_name)$>

loadSchemaData

Loads the data from a schema resultset into the local data of the current data binder.

Type and Usage

Parameters

This function can take zero, one, or two parameters.

Example

<$loadSchemaData()$>

See Also


MailServer

Defines the e-mail server that is used to process e-mails.

E-mail support is required for workflow notifications, subscription notifications, and project notifications in Collaboration Server.

There is no default value.

Type and Usage

Location

Example

Used as a configuration entry:

MailServer=mail.example.com

See Also


MajorRevSeq

Defines the major sequence for revision numbers.

Returns the major revision label sequence (returns the value of the configuration setting).

Returns a string.

Default is 1-99.

Type and Usage

Location

Example

As a configuration setting:

MajorRevSeq=A-Z

As script, returns the value of the configuration setting:

<$MajorRevSeq$>

See Also


MaxCollectionSize

Defines the number of files to be passed to the Indexer in one batch.

Valid range is 1 to 65535.

A value of 2000 is recommended for large index collections. Lower values will result in inefficient indexing performance.

Returns the number of files per batch.

Default is 25.

Type and Usage

Location

Example

As a configuration setting, defines the batch size:

MaxCollectionSize=25

As script, returns the value from configuration files:

<$MaxCollectionSize$>

MaxDocIndexErrors

Sets the number of errors after which the Indexer stops indexing or rebuilding.

Default is 50.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

MaxDocIndexErrors=50

MaxIntegerAllowed

Sets the maximum value allowed in custom Integer metadata fields.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

MaxIntegerAllowed=1000000

See Also


MaxQueryRows

Sets the maximum number of rows that are displayed in the Repository Manager, Active Report pages, and the Work In Progress page.

Increasing this value will slow response time.

Default is 200.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

MaxQueryRows=50

See Also


MaxRequestThreadCount

Sets the maximum number of simultaneous request threads.

Default is 100.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

MaxRequestThreadCount=50

MaxResults

Sets the maximum number of content items returned from a search query using the Oracle WebCenter Content Server user interface.

Specifying a value overrides the programmed default.

There is no default value. The maximum number of results that can be returned is 200.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

MaxResults=200

MaxSavedSearchResults

Sets the maximum number of saved searches a user can make. Specifying a value overrides the default (10).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

MaxSavedSearchResults=25

MaxSearchConnections

Sets the maximum number of search connections that are open simultaneously.

For example, if MaxSearchConnections=5 and six search requests are made at the same time, the sixth request goes into a queue until one of the first five requests is completed.

Default is 10.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

MaxSearchConnections=5

MaxSizeResourceFileCacheMillions

Sets the maximum size of resource files, in millions of double-byte characters.

This value limits the size of files before they are read in and parsed.

Multiply file sizes by 2.5 to get a better estimate of true size in memory.

Default is 10.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

MaxSizeResourceFileCacheMillions=20

MaxStandardDatabaseResults

Sets the maximum number of users displayed.

This is valid for any applet that allows you to select users from a list.

Default is 500.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

MaxStandardDatabaseResults=1000

MemoFieldSize

Defines the field size created in the database for memo fields.

Ensure that the database supports whatever size is chosen.

Default is 255 characters.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

MemoFieldSize=300

See Also


MinIntegerAllowed

Sets the minimum value allowed in custom Integer metadata fields.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

MinIntegerAllowed=0

See Also


MinMemoFieldSize

Defines the size at which a custom metadata field is defined as a memo field rather than a long text field.

If the field sizes of the DocMeta table have been edited directly in the database, the Oracle WebCenter Content Server system classifies the varchar field types by their lengths.

Default is 255 characters.

The following field type rules apply when this setting is defined:

Field Type Evaluation Rules
Text <50
Long Text >= 50 and < MinMemoFieldSize
Memo >= MinMemoFieldSize

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

MinMemoFieldSize=300

See Also


MinorRevSeq

Defines the minor sequence for revision numbers.

Returns the minor revision label sequence (returns the value of the configuration setting).

Returns a string.

Type and Usage

Location

Example

As a configuration setting:

MinorRevSeq=a-c

As script, returns the value of the configuration setting:

<$MinorRevSeq$>

See Also


NoAutomation

Disables all automated Oracle WebCenter Content Server activity.

This setting overrides the IsAutoArchiver, IsAutoQueue, and IsAutoSearch settings.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

NoAutomation=true

See Also


NoMatches

Checks whether matches were found from a search query.

Generally used to display a message on the search results page.

Type and Usage

Output

Example

Displays text if no matches were found from a query:

<$if NoMatches$>
    <p><font face="arial" size="2">
    Found no matches out of <$TotalDocsProcessed$> documents searched matching the query.</p>
<$endif$>

NoSearchConnectionCloseOnDocChange

Disables automatic closure of all search connections when a document has been modified (inserted, updated, or deleted).

Caution:

Setting this to TRUE may lead to incorrect search results when the system is under high stress.

When set to TRUE, search connections stay open even when a document is changed.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

NoSearchConnectionCloseOnDocChange=true

NotificationIntervalInDays

This configuration variable defines how often a notification query is run. Notification queries define the criteria used to search for expired content.

If NotificationIntervalInDays is not set, the default value is one day.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

NotificationIntervalInDays=3

See Also


NotificationMaximum

This configuration variable defines the maximum number of content items that will be returned by a notification query. Notification queries define the criteria used to search for expired content.

If NotificationMaximum is not set, the default value is 1000.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

NotificationMaximum=500

See Also


NotificationQuery

This setting defines criteria for the automatic query that searches for expired content.

If NotificationQuery is not set, the default value is all content that expires in the next seven days.

Type and Usage

Parameters

There is one parameter, the query to be used. The query can be one of the following. See the EXAMPLES section for sample queries.

Location

IntradocDir/config/config.cfg

Example

Idoc Script Example

When used in conjunction with database indexing, the following query provides email notification for all documents that expire in seven days:

NotificationQuery=dOutDate < '<$dateCurrent(7)$>'>

URL Encoded Example

The following query returns all content expiring after August 1, 2007. The URL from the browser address line is copied, beginning with the QueryText portion:

NotificationQuery=QueryText=dOutDate+%3C+%608%2F1%2F06%60&SearchProviders= [...}

Plain Text Query

The following query returns all content expiring after August 1, 2007:

NotificationQuery=8/1/07

See Also


NotifyExtras

This configuration variable defines the users who will receive a list of expired content in addition to the authors of each content item. Notification queries define the criteria used to search for expired content.

If the NotifyExtras setting is in the config.cfg file but has no value defined, no extra notification is sent.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

NotificationExtras=jwilson, nadams

See Also


NotifyTime

This configuration variable defines the time of day the notification query is run, specified in 24-hour notation. Notification queries define the criteria used to search for expired content.

If NotifyTime is not set, the default value is midnight (00:01).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

The following example sets the time to 11:30 AM:

NotifyTime=11:30

The following example sets the time to 1:30 PM:

NotifyTime=13:30

See Also


NtlmSecurityEnabled

Enables Windows network authentication for the Oracle WebCenter Content Server instance.

This option is available only when using an IIS web server.

When set to TRUE, users defined on a Windows network (NTLM) or in Active Directory can log in to the Oracle WebCenter Content Server instance using their network credentials.

Default is FALSE.

Type and Usage

Location

Example

Enables NTLM security:

NtlmSecurityEnabled=true

See Also


NumConnections

Sets the number of open connections to the database. Default is 15. The default for standalone applets is 4.

This setting applies to the Oracle WebCenter Content Server instance and any standalone applications and utilities, so each application will use the specified number of connections.

If your database does not allow enough connections to be open at one time, an error will occur when you attempt to start an application or utility.

To avoid this problem, you can isolate the NumConnections setting for the Oracle WebCenter Content Server instance from the setting for applications and utilities as follows:

  1. Specify the NumConnections setting for the Oracle WebCenter Content Server instance in the DomainHome/ucm/cs/bin/intradoc.cfg file rather than IntradocDir/config/config.cfg.

  2. Make a copy of the DomainHome/ucm/cs/bin directory and give it a unique name (such as DomainHome/ucm/cs/applet_bin/).

  3. Set the NumConnections value for application and utilities in the intradoc.cfg file in the new directory (for example, NumConnections=2).

  4. Run applications and utilities from the new directory (change any scripts and shortcuts in Windows), but continue to run the Oracle WebCenter Content Server instance from the DomainHome/ucm/cs/bin/ directory.

If necessary, you can create a separate directory and NumConnections setting for each application and utility.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

NumConnections=10

OneMatch

Checks if only one match was found from a search query.

Generally used to display a message on the search results page.

Type and Usage

Output

Example

Displays text if only one match was found from a query:

<$if OneMatch$>
    <p><font face="arial" size="2">
    Found <$TotalRows$> document matching the query.</p>
<$endif$>

PATH_INFO

This setting is obsolete. The web server filter no longer sends this information.

Retrieves additional information about the file system path to the CGI computer.

When the virtual path is returned by the PATH_TRANSLATED variable, any additional information at the end of this path is also returned as PATH_INFO.

This variable is specific to the current gateway program request.

Type and Usage

Output

Returns the additional virtual path information as a string.

Example

Retrieves additional CGI path information:

<$PATH_INFO$>

See Also


PATH_TRANSLATED

Retrieves the file system path to the CGI computer, for example:

c:/domain/weblayout/idcplg/idc_cgi_isapi-idcm1.dll.

This variable is specific to the current gateway program request.

Type and Usage

Output

Returns the virtual path as a string.

Example

Retrieves the CGI path:

<$PATH_TRANSLATED$>

PLUGIN_DEBUG

Enables logging of events that occur inside the web server plug-in filters.

When set to TRUE, events that occur inside any plugins that understand this flag will be recorded in the following log file:

When changing this setting on Apache on the Oracle WebCenter Content Server instance, only the Oracle WebCenter Content Server instance must be restarted.

Default is FALSE.

Type and Usage

Location

IntradocDir/data/users/SystemFilters.hda

Example

Used as a configuration entry:

PLUGIN_DEBUG=true

PrimaryWorkQueueTimeout

Sets the number of seconds until workflow and subscription notification e-mails are sent.

Set this to a lower number if you do not want e-mails to be delayed or if you want immediate response during debugging. Note that a small number could use a large amount of resources.

The Oracle WebCenter Content Server has an e-mail message buffer of 20000 bytes. If a large number of subscription notification e-mails are triggered in a short period of time (for example, 40 content items with 40 subscribers each), the buffer can become overloaded and the notification e-mails will not be sent. The following Oracle WebCenter Content Server error message indicates that the buffer was overloaded: Work queue error: Error while collating work queue (Message to append to queue 'CollatedWorkQueue' was too large.)

The limit to the total size of a subscription notification e-mail sent is 1GB. The total number of subscription notification e-mails that can be included in one e-mail sent to n users is 1GB divided by the size of the subscription notification e-mail.

Default is 600 (10 minutes).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

PrimaryWorkQueueTimeout=30

Priority

Specifies the order in which LDAP providers will be checked for the user credentials.

This field is used only when a user has not previously logged into the Oracle WebCenter Content Server instance. If the user has previously requested credentials, the SourcePath will be stored for that user, so the LDAP provider specified by the Source Path will be used.

Each LDAP provider in the Oracle WebCenter Content Server instance must have a unique Priority number.

Default is 1.

Type and Usage

Location

Example

Used as a configuration entry:

Priority=2

See Also


ProviderClass

Specifies the name of a Java class that implements the provider.

The default depends on the type of provider:

Provider Type Default Value
Outgoing intradoc.provider.SocketOutgoingProvider
Database intradoc.jdbc.JdbcWorkspace
Incoming intradoc.provider.SocketIncomingProvider
Preview intradoc.provider.SocketOutgoingProvider
Ldapuser intradoc.provider.LdapUserProvider

Type and Usage

Location

Example

Used as a configuration entry:

ProviderConnection=intradoc.provider.SocketOutgoingProvider

ProviderConfig

Specifies the name of a Java class that performs some extra configuration for a provider.

This setting is most useful for database providers, where the connection classes are already providers.

There is no default.

Type and Usage

Location

Example

Used as a configuration entry:

ProviderConfig=intradoc.provider.CustomClass

ProviderConnection

Specifies the name of a Java class that implements the provider connection.

The default depends on the type of provider:

Provider Type Default Value
Outgoing intradoc.provider.SocketOutgoingConnection
Database intradoc.jdbc.JdbcConnection
Incoming intradoc.provider.SocketIncomingConnection
Preview intradoc.provider.SocketOutgoingConnection
Ldapuser intradoc.provider.LdapConnection

Type and Usage

Location

Example

Used as a configuration entry:

ProviderConnection=intradoc.provider.SocketOutgoingConnection

ProviderCredentialsMap

Specifies the name of a Credentials Map for use with JpsUserProvider.

There is no default.

Type and Usage

Location

Example

Used as a configuration entry. Add the line before the "@end" line in the file. The last lines of the file should look similar to:

SourcePath=jpsuser
ProviderClass=idc.provider.jps.JpsUserProvider
ProviderCredentialsMap=name_of_map
@end

ProviderType

Specifies the type of provider.

The following provider types are available:

Provider Type Value
Outgoing outgoing
Database database
Incoming incoming
Preview preview
Ldapuser ldapuser

Type and Usage

Location

IntradocDir/data/providers/provider_name/provider.hda

Example

Used as a configuration entry:

ProviderType=ldapuser

QUERY_STRING

Retrieves the string that follows the ? delimiter in the URL for a query.

This variable is specific to the current CGI request.

Type and Usage

Output

Returns the query information as a string.

Example

As information output on a page or to a log:

QUERY_STRING=IdcService=GET_DOC_PAGE&Action=GetTemplatePage&Page=STD_QUERY_PAGE

As part of an Idoc Script statement or evaluation:

<$if QUERY_STRING$>
<!--statement-->

RedirectHostsFilter

Used to indicate a filter of allowed redirect hosts. The current host is added to this filter by default.

Use a pipe character | to separate multiple addresses. Make sure there are no spaces on either side of the pipe.

Use wildcards to indicate groups of addresses (* for zero or more characters, ? for a single character).

Default is the URL of the local host.

Type and Usage

Location

Example

Used as a configuration entry:

RedirectHostsFilter=*.google.com|www.cnn.com

regexMatches

Searches a string for a specific pattern using a regular expression to do matching. Regular expression constructs can contain characters, character classes, and other classes and quantifiers. For details about the Java API for Class Pattern, see http://www.oracle.com/technetwork/java/index.html.

This feature is only available with JVM 1.4 or later versions; this is the default version for Oracle WebCenter Content Server version 7.0 and later.

Type and Usage

Parameters

This function takes two parameters:

Example

The following example returns FALSE, because the string does not match the expression:

<$regexMatches("abcdef","abc")$>

The following example returns TRUE because the wild cards are present. If standard wild cards such as the asterisk (*) were used instead of the dot-asterisk (.*) convention, the match would fail.

<$regexMatches("abcdef", ".*abc.*")$>

See Also


regexReplaceAll

Searches a string for a specific pattern using a regular expression to do matching and replacing. Regular expression constructs can contain characters, character classes, and other classes and quantifiers. For details about the Java API for Class Pattern, see http://www.oracle.com/technetwork/java/index.html.

This feature is only available with JVM 1.4 or later versions; this is the default version for Oracle WebCenter Content Server version 7.0 and later.

It replaces all instances of the regular expression with the replacement string.

Type and Usage

Parameters

This function takes three parameters:

Example

The following example returns xyzdef xyzdef:

<$regexReplaceAll("abcdef abcdef","abc","xyz")$>

See Also


regexReplaceFirst

Searches a string for a specific pattern using a regular expression to do matching and replaces the first instance with a replacement string. Regular expression constructs can contain characters, character classes, and other classes and quantifiers. For details about the Java API for Class Pattern, see http://www.oracle.com/technetwork/java/index.html.

This feature is only available with JVM 1.4 or later versions; this is the default version for Oracle WebCenter Content Server version 7.0 and later.

Type and Usage

Parameters

This function takes three parameters:

Example

The following example returns xyzdef abcdef:

<$regexReplaceFirst("abcdef abcdef","abc","xyz")$>

See Also


REMOTE_ADDR

Returns the IP address of the remote host making the request.

This variable is specific to the current gateway program request.

Type and Usage

Output

Returns the IP address as a string.

Example

As information output on a page or to a log:

REMOTE_ADDR=207.0.0.1

As part of an Idoc Script statement or evaluation:

<$if REMOTE_ADDR$>
<!--statement-->

See Also


REMOTE_HOST

Returns the name of the remote host making the request.

This variable is specific to the current gateway program request.

Type and Usage

Output

Example

As information output on a page or to a log:

REMOTE_HOST=207.0.0.1

As part of an Idoc Script statement or evaluation:

<$if REMOTE_HOST$>
<!--statement-->

See Also


REQUEST_METHOD

Retrieves the method that was used to make the request.

This variable is specific to the current gateway program request.

Type and Usage

Output

Returns the request method as a string.

Example

As information output on a page or to a log:

REQUEST_METHOD=GET

As part of an Idoc Script statement or evaluation:

<$if REQUEST_METHOD$>
<!--statement-->

ResultsTitle

Defines a title for the search results page.

This variable is used by the Web Layout Editor to name the search results page and display a heading at the top of that page.

Type and Usage

Output

Returns the page title as a string.

Example

As an HDA entry, names the search results page:

@Properties LocalData
ResultsTitle=Content Items
@end

As a script, returns the defined name:

<$if ResultsTitle$>ResultsTitle=<$url(ResultsTitle)$>

SchemaAllowRecursiveFileMove

If set to TRUE, enables the ability to move files on UNIX systems on an individual basis from a schema publishing location into the production location. This allows swapping of the schema directory into its production directory.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

SchemaAllowRecursiveFileMove=true

SchemaBuildDigestFile

If set to TRUE, builds a file containing digests of all the files published. Setting this to TRUE increases the time required to publish schema.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

SchemaBuildDigestFile=true

See Also


SchemaPublishCheckInterval

Establishes the interval between checks for non-subject-driven schema publishing requests.

This is triggered if the data/schema/publishlock/publish.dat file is accessed.

Specify the value in seconds.

Default is 120 seconds (two minutes).

Change this setting if there is an external program that modifies data in schema-managed tables and which accesses the file IntradocDir/data/schema/publishlock/publish.dat.

On a development server, use a low value to ensure prompt publishing (for example, SchemaPublishCheckInterval=2).

Lowering the default value on a production server may cause performance problems.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

To set this interval for 10 minutes, use the following:

SchemaPublishCheckInterval=600

SchemaPublishInterval

The interval between unprovoked schema operations (that is, operations that are not caused by an event).

Specify this value in seconds.

Default is 14400 (four hours).

SchemaPublisher will usually publish at least once during this interval.

On a development server, use a low value to ensure prompt publishing (for example, SchemaPublishInterval=30).

Lowering the default value on a production server may cause performance problems.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

To set this interval to one week, use the following:

SchemaPublishInterval=604800

SchemaPublishMaximumInterval

The maximum amount of time between automatic schema publishing cycles.

Specify this value in seconds.

Default is 86400 (one day).

On a development server, set a low value to ensure prompt publishing (for example, SchemaPublishMaximumInterval=30).

Lowering the default value on a production server may cause performance problems.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

To specify this value as four hours, use the following:

SchemaPublishMaximumInterval=14400

SchemaPublishMinimumInterval

The minimum amount of time between automatic schema publishing cycles.

Specify this value in seconds.

Default is four seconds.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

SchemaPublishMinimumInterval=8

SchemaPublishRenameRetryInitialInterval

Specifies the delay before retrying a rename operation.

The rename operation involves renaming of the schema directory to schema.old or the schema.work directory to schema.

After a failed retry, the delay value is doubled.

If SchemaPublishRenameRetryIterations is reached, the publishing operation fails.

Specify the value in milliseconds.

The default value is 100 milliseconds.

This affects behavior on Windows systems only.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

SchemaPublishRenameRetryInitialInterval=50

See Also


SchemaPublishRenameRetryIterations

Specifies the number of times a rename operation will be tried.

This affects operations on Windows systems only.

The operation involves renaming of the schema directory to schema.old or the schema.work directory to schema.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

SchemaPublishRenameRetryIterations=6

See Also


SchemaPublishRetryInterval

Specifies the delay introduced after SchemaPublisher fails to publish the schema.

This delay prevents the SchemaPublisher from continually starting and failing.

After a failed retry, this value is doubled but is never larger than the value of SchemaPublishRetryIntervalMax.

When publishing succeeds, the value is reset to the original value

Default value is three seconds.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

SchemaPublishRetryInterval=4

See Also


SchemaPublishRetryIntervalMax

Specifies the longest length of time for SchemaPublishRetryInterval.

Specify this value in seconds.

Default value is 300 (five minutes).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

SchemaPublishRetryIntervalMax=120

See Also


SchemaVerifyPublishing

If set to TRUE, digests will be used to verify the files that SchemaPublisher creates before doing the final renaming.

Setting SchemaVerifyPublishing=TRUE will increase the time required to publish schema.

This should be set to TRUE on a production server.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

SchemaVerifyPublishing=true

See Also


SchemaWin32RenameDelayInterval

Specifies the size of the delay prior to closing a file before attempting to rename it.

This affects behavior only on Windows systems.

Tune this number as low as possible.

Value should be specified in milliseconds.

The default value is 10 milliseconds.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

SchemaWin32RenameDelayInterval=4

SCRIPT_NAME

Retrieves the relative path to the CGI linking file.

The CGI linking file is the executable file for the web server security filter, which is a different file for each operating system and web server. For example, the file name is nph-idc_cgi.exe for Solaris.

Type and Usage

Output

Returns the relative path as a string.

Example

As information output on a page or to a log:

SCRIPT_NAME=/idcplg/idc_cgi_isapi-instance>.dll

As part of an Idoc Script statement or evaluation:

<$if SCRIPT_NAME$>
<!--statement-->

SearchCacheCleanerInterval

Sets the time between search cache cleanup attempts in seconds.

Default is 120 (2 minutes).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

SearchCacheCleanerInterval=60

SearchCacheHardLimit

Defines the maximum number of results that will be included in the search cache when a search request includes the hard limit.

If the end row is larger than SearchCacheSoftLimit but less than or equal to SearchCacheHardLimit, the search cache contains all rows from 1 to SearchCacheHardLimit.

If the end row is larger than SearchCacheHardLimit, nothing is cached for the search.

Typically, this setting should match the maximum number of search results displayed per page. See MaxResults.

Default is 200.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

SearchCacheHardLimit=300

See Also


SearchCacheMaxItemAgeInMinutes

Sets the maximum age of an item in the search cache in minutes.

Default is 60 (1 hour).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

SearchCacheMaxItemAgeInMinutes=30

SearchCacheSoftLimit

Defines the maximum number of results that will be included in the search cache when a search request includes the soft limit.

Typically, this setting should match the default number of search results displayed per page.

Default is 25.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

SearchCacheSoftLimit=50

See Also


SearchCacheTrace

Obsolete as of the 7.0 release. The functionality is now available in the System Audit Information page.

Dumps trace information to the console for the search cache cleaning algorithm.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

SearchCacheTrace=true

SearchConnectionWaitTimeout

Sets the search connection wait timeout in milliseconds.

This is the maximum amount of time that a search request waits in the queue before the search is refused.

Default is 60000 (1 minute).

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

SearchConnectionWaitTimeout=120000

SearchDebugLevel

Defines the level of detail for entries in the Indexer log files.

The log files are located at /weblayout/groups/secure/logs/.

The following list shows the debug levels:

Level Description
none No log is generated. This is the default.
verbose Displays information for each file accessed. Indicates indexed, ignored, or failed, and generates a full report.
debug Additional information at the functional level is generated.
trace Information is logged as each activity is performed.
all A full report including debug, trace, and verbose information is generated.

Tip:

If you set the debug level to anything but none, a log file will be generated for each index cycle. You may need to perform system maintenance periodically to reduce the number of log files.

Type and Usage

Location

Example

Used as a configuration entry:

SearchDebugLevel=all

SearchDir

Defines the path to the search directory.

The default value is DomainHome/ucm/cs/search

Type and Usage

Location

DomainHome/ucm/cs/bin/intradoc.cfg

Example

Used as a configuration entry:

SearchDir=f:/search/

SearchIndexerEngineName

This variable specifies the name of the search engine to use. Supported values include:

Each search engine uses its own format for query strings. The default uses universal query syntax, but database search requires SQL syntax.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

SearchIndexerEngineName=DATABASE

SearchQueryFormat

Retrieves search query pages with query syntax that is recognized regardless of supported search engines.

If used dynamically, appends the following to the URL:

SearchQueryFormat=Universal

When used dynamically, the universal search syntax is maintained through one search session. The syntax is maintained on a query page, result page and its navigation link and during actions such as searching within the page or saving the query. It is maintained until the user clicks the menu selection to re-load a search query page.

This can also be added to the config.cfg file so that the universal search query page is always used.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

SearchQueryFormat=Universal

See Also


SearchQueryTrace

This variable is obsolete.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

SearchQueryTrace=true

SelfRegisteredAccounts

Defines the default accounts and permissions to be given to self-registered users.

This is a comma-delimited list.

Permissions for each account must be specified in parentheses after the account name.

The #none entry grants privileges to content items that have no account assigned. The #all entry grants privileges to all accounts.

There is no default value.

Returns the list of accounts as a string.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

SelfRegisteredAccounts=#none(RWDA),USERS/<$NewUser$>,BOS(R)

As script, returns the defined account information as a string:

<$SelfRegisteredAccounts$>

See Also


SelfRegisteredRoles

Defines the default roles to be given to self-registered users.

This is a comma-delimited list.

There is no default value.

Returns the roles as a string.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration setting:

SelfRegisteredRoles=guest,salesRole

As script, returns the defined roles as a string:

<$SelfRegisteredRoles$>

See Also


SERVER_NAME

Retrieves the hostname, DNS alias, or IP address of the web server as it would appear in a self-referencing URL.

This variable is not request-specific; it is set for all requests.

Type and Usage

Output

Returns the server information as a string.

Example

As information output on a page or to a log:

SERVER_NAME=centralserver

As part of an Idoc Script statement or evaluation:

<$if SERVER_NAME$>
<!--statement-->

SERVER_PORT

Retrieves the web server port number to which the request was sent.

This variable is specific to the current gateway program request.

Type and Usage

Output

Returns the port number as a string.

Example

As information output on a page or to a log:

SERVER_PORT=80

As part of an Idoc Script statement or evaluation:

<$if SERVER_PORT$>
<!--statement-->

SERVER_PROTOCOL

Returns the protocol and revision of the incoming request.

This variable is specific to the current gateway program request.

Type and Usage

Output

Returns a string in the format protocol/revision.

Example

As information output to a log:

SERVER_PROTOCOL=HTTP/1.0

As part of an Idoc Script statement or evaluation:

<$if SERVER_PROTOCOL$>
<!--statement-->

SERVER_SOFTWARE

This setting is obsolete for the 7.0 version and later. The web server filter no longer sends this information.

Returns the name and version of the web server software that is answering the request.

This is also the server running the gateway.

This variable is not request-specific; it is set for all requests.

Type and Usage

Output

Returns a string in the format name/version.

Example

As information output on a page or to a log:

SERVER_SOFTWARE=Microsoft-IIS/4.0

As part of an Idoc Script statement or evaluation:

<$if SERVER_SOFTWARE$>
<!--statement-->

ServiceStartupTimeout

Sets the Oracle WebCenter Content Server startup timeout value. This configuration setting applies only to Oracle WebCenter Content Server instances running on a Microsoft Windows platform.

Used to modify the server startup timeout value when a service requires more time to start up than is provided by the default Oracle WebCenter Content Server startup timeout value, which is 120 seconds (2 minutes).

The value must be specified in seconds.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

The following example sets the startup timeout value to 240 seconds (4 minutes):

ServiceStartupTimeout=240

setCookie

Sets a cookie value in a browser.

Used to retain session information or information about anonymous users.

An expiration date can also be passed to make the cookie expire at a specified time.

Important:

Do not store secure data in a cookie. You should limit the use of cookies due to the risk of malicious users setting cookies on your site.

Type and Usage

Parameters

This function can take three parameters:

Example

The following example sets the cookie myCounter in the user's browser and increments the value when the user visits the page. The cookie will expire in one day.

<$myCounter=getCookie("myCounter")$>
<$if not myCounter$>
    <$myCounter=1$>
<$endif$>
Num times loaded: <$myCounter$>
<$setCookie("myCounter", myCounter+1, dateCurrent(1))$>

See Also


ShowCreateExternalMenu

This Oracle WebCenter Content Server configuration variable is specific to the Oracle WebCenter Content: Records (Records) system. Set this variable to true to display the following create external source features in your interface:

When set to false, these features will not be displayed.

The default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

ShowCreateExternalMenu=true

ShowOnlyKnownAccounts

Defines whether to display only predefined accounts on checkin and search pages.

Default is an empty string.

Type and Usage

Location

Example

Used as a configuration entry:

ShowOnlyKnownAccounts=true

SingleGroup

Evaluates if the current revision is in a contributor step of a Basic workflow.

Type and Usage

Output

Example

Evaluates if revision is in a contributor step:

<$if not SingleGroup$>

SkipMozillaMailToWorkaround

Used to disable an email solution that allows Mozilla mail applications to accurately handle email from the Search Result and Content Info page. If your mailer does not send correctly formatted email, set this variable to TRUE.

Type and Usage

Location

Example

Disables special email handling:

SkipMozillaMailToWorkaround=true

SmtpPort

Defines the Simple Mail Transfer Protocol (SMTP) port number.

Default is 25.

Type and Usage

Location

Example

Used as a configuration entry:

SmtpPort=25

See Also


SocketHostAddressSecurityFilter

Defines the IP addresses that are allowed to make calls to the Oracle WebCenter Content Server instance.

Either this setting or SocketHostNameSecurityFilter is required to allow remote IdcCommandX calls to the Oracle WebCenter Content Server instance. (Generally, both settings should not be used at the same time.) For more information, see Oracle WebCenter Content Developer's Guide for Content Server.

Use a pipe character | to separate multiple addresses. Make sure that there are no spaces on either side of the pipe.

Use wildcards to indicate groups of addresses (* for zero or more characters, ? for a single character).

Default is the IP address of the local host.

Type and Usage

Location

Example

Used as a configuration entry:

SocketHostAddressSecurityFilter=10.10.3.*|127.0.0.1

See Also


SocketHostNameSecurityFilter

Defines the server names that are allowed to make calls to the Oracle WebCenter Content Server instance.

Either this setting or SocketHostAddressSecurityFilter is required to allow remote IdcCommandX calls to the Oracle WebCenter Content Server instance. (Generally, both settings should not be used at the same time.) See the Oracle WebCenter Content Developer's Guide for Content Server.

Use a pipe character | to separate multiple server names. Make sure that there are no spaces on either side of the pipe.

Type and Usage

Location

Example

Used as a configuration entry:

SocketHostNameSecurityFilter=olympus|localhost|zeus

See Also


SourceID

Provides the Content ID for the current dynamic server page.

This variable returns the same value as ref:dID. See Referencing Metadata in Dynamic Server Pages.

Type and Usage

Output

Returns the Content ID as a string.

Example

Sets the dID variable to the value of the current HCSF page:

<input type=hidden name="dID" value="<$SourceID$>">

SourcePath

Specifies a unique string that identifies an LDAP provider. The first time a user requests credentials through the provider, this string is stored with the user information so it can be used to match the user with the provider next time the user asks for credentials.

We suggest using the name of the LDAP provider as the Source Path.

There is no default.

Type and Usage

Location

Example

Used as a configuration entry:

SourcePath=LdapProvider1

See Also


StatusCode

Indicates if the last function call was successful or failed. This variable is set at the end of a service call.

Certain functions set this variable to zero (0) upon success.

Certain functions set this variable to a negative numeric value (-1) upon failure. Typically, the abortToErrorPage function is called to display an error page with the StatusMessage from the most recent function call.

Type and Usage

Output

Example

Returns the current status code:

<$StatusCode$>

See Also


StatusMessage

Defines the error message for the last function call. This variable is set at the end of a service call, but it can be set during a service call.

This variable is typically displayed on an error page when the abortToErrorPage function is called.

Type and Usage

Output

Example

Returns the current status message:

<$StatusMessage$>

See Also


stdSecurityCheck

Checks if the current user has access to the requested content item based on the standard security model.

The active data is checked to determine if the standard (or default) security model allows the user to have access to the content item. This enables a custom implementation of security to still execute the standard security model as a baseline.

Type and Usage

Parameters

None.

Output

Example

Compares the permission level of the user to the requested content item:

<$stdSecurityCheck()$>

SubscriptionCollatedFieldList

Defines a list of fields displayed for subscriptions.

The default fields that are defined at startup are dID and dDocName.

Additional fields can be defined using AdditionalSubscriptionCollatedFieldList.

It is recommended that you use AdditionalSubscriptionCollatedFieldList to add subscription fields to the collated list rather than change SubscriptionCollatedFieldList.

Type and Usage

Location

IntradocDir/config/config.cfg

See Also


SubscriptionMethod

Specifies how subscriptions are processed.

The possible values are:

Default is SubscriptionOriented.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

SubscriptionMethod=DocumentOriented

TextIndexerFilterValidateFormats

This variable specifies a comma-delimited list of file types that are verified for unreadable characters. When this variable is used, specified file formats are checked for unreadable characters and those characters are corrected before the text file is passed to be indexed.

Type and Usage

Location

DomainHome/ucm/cs/TextIndexerFilter/textindexerfilter_einviornment.cfg

Example

TextIndexerFilterValidateFormats=application/pdf

TimeoutPerOneMegInSec

Sets the timeout for indexing files into the index collection.

Default is 600 seconds per megabyte.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

TimeoutPerOneMegInSec=3000

UieHideSearchCheckboxes

Records Manager only.

Controls if the metadata field check boxes on the search page are shown.

If set to TRUE, the metadata field check boxes are not shown on the page. If set to FALSE, the metadata field check boxes are shown.

The default is TRUE.

Type and Usage

Location

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

DomainHome/ucm/urm/RetentionManager/retentionmanager_environments.cfg

Example

Used as a configuration entry:

UieHideSearchCheckboxes=false

UniversalSearchAllowFullText

Changes the displayed fields when SearchQueryFormat=Universal is used. If UniversalSearchAllowFullText is set to FALSE, the Full Text Search field is not displayed on the Search page.

The default is TRUE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

UniversalSearchAllowFullText=false

See Also


UseAccounts

Enables the use of accounts.

When set to TRUE, accounts are enabled.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

UseAccounts=true

UseAdsi

Enables Active Directory (ADSI) authentication for the Oracle WebCenter Content Server instance.

This setting is valid only when NtlmSecurityEnabled is TRUE.

This option is available only when using an IIS w server.

When set to TRUE, users defined in Active Directory can log in to the Oracle WebCenter Content Server instance using their network credentials.

There is no default value.

Type and Usage

Location

Example

Enables ADSI security:

UseAdsi=true

See Also


UseDatabaseShortIndexName

Required if the database in use does not support index names longer than eighteen characters.

When set to TRUE, short index names are used.

When set to FALSE, short index names are not used.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

UseDatabaseShortIndexName=false

UseHtmlOrTextHighlightInfo

Checks whether full-text search keyword highlighting is enabled and the file format supports highlighting (such as PDF, HTM, or TXT).

If the EnableDocumentHighlight setting is TRUE, keyword highlighting is enabled.

Type and Usage

Output

Example

Returns search keyword highlighting status:

<$UseHtmlOrTextHighlightInfo$>

See Also


UseNetscape

Specifies the method used to connect to an LDAP server through a provider.

Default is TRUE.

Type and Usage

Location

Example

Used as a configuration entry:

UseNetscape=0

UseNtlm

Enables NT LAN Manager (NTLM) authentication for the Oracle WebCenter Content Server instance.

There is no default value.

Type and Usage

Location

Example

Enables NTLM security:

UseNtlm=true

See Also


UseRevisionCreateDate

When this variable is set in the system importing an archive, the Archiver uses the dCreateDate for comparisons.

This allows the Oracle WebCenter Content Server system to differentiate revisions by their initial create date and not by the assigned dInDate.

This is not set by default.

Important:

Use this configuration setting if no legacy content from older versions (pre 7.5) of Oracle WebCenter Content Server are being imported.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

UseRevisionCreateDate=true

UserFilteredSubjects

Specifies the subjects that must be refreshed if the current user's security credentials have changed.

Default is users,accounts.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

UserFilteredSubjects=users,accounts,licenses

userHasAccessToAccount

This function returns TRUE if the user has access to a named account at a specific privilege level. The privilege is a one-character representation of the access level, as follows:

Type and Usage

Parameters

Takes two parameters:

Output

Example

Evaluates whether the user has Read access to the specified account:

<$userHasAccessToAccount("profile_account", 1)$>

Evaluates whether the user has Read and Write access to the specified account:

<$userHasAccessToAccount("profile_account", 3)$>

userHasGroupPrivilege

This function returns TRUE if the user has the specified privilege to the specified group. The privilege is a one-character representation of the access level, as follows:

Type and Usage

Parameters

Takes two parameters:

Output

Example

Evaluates whether the user has the specified role:

<$userHasGroupPrivilege("Public", "R")$>
<$userHasGroupPrivilege("Secure", "A")$>

userHasRole

Checks if the current user has a particular role.

Type and Usage

Parameters

The only parameter is the name of a role.

Output

Example

Evaluates whether the user has the specified role:

<$userHasRole("admin")$>

UserIsAdmin

Checks if the current user has rights to any administration applets.

Type and Usage

Output

Example

Evaluates administrative rights of user:

<$UserIsAdmin$>

See Also


UseSearchCache

When set to TRUE, enables the search cache.

The search cache improves search performance by caching recent search engine queries.

Default is TRUE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

As a configuration variable:

UseSearchCache=true

If this variable is set to FALSE and used on the CGI line of a browser URL request doing a query, it forces the query to execute each time. This makes it possible to measure the speed of the query being executed and to verify the cache results (because a new search result is generated each time).

http://...?IdcService=GET_SEARCH_RESULTS&...UseSearchCache=false 

UseSecureLdap

Specifies whether SSL is used with the LDAP provider.

Default is FALSE.

Type and Usage

Location

Example

Used as a configuration entry:

UseSecureLdap=true

See Also


UseSSL

Enables the secure sockets layer (SSL).

Default is FALSE.

Type and Usage

Location

Example

As a configuration setting, enables SSL:

UseSSL=true

As script, returns the value of the configuration setting:

<$UseSSL$>

See Also


UseXmlUrl

Checks if search keyword highlighting for XML documents is enabled. When set to TRUE, an XML URL is constructed when performing a keyword search.

Type and Usage

Output

Example

Returns the status of search keyword highlighting for XML documents.

<$UseXmlUrl$>

See Also


WebServerAuthOnly

Specifies whether the web server filter will authenticate users that are defined in the Oracle WebCenter Content Server database.

Default is FALSE.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry to enable web server authorization only:

WebServerAuthOnly=true

wfAction

Retrieves the action that is currently being performed on the revision.

Type and Usage

Output

Returns the name of the action as a string.

Example

If the revision is in the process of being rejected, notify the original author:

<$if wfAction like "REJECT"$>
    <$wfSet("wfJumpName", "notifyAuthor")$>
    <$wfSet("wfJumpEntryNotifyOff", "0")$>
    <$wfNotify(dDocAuthor, "user")$>
<$endif$>

If the revision is currently being approved but the metadata value of xDept is not HR, terminate the approval and display an error page:

<$if wfAction like "APPROVE" and not(xDept like "HR")$>
    <$abortToErrorPage("The revision is not in HR.")$>
<$endif$>

wfAddActionHistoryEvent

Inserts an event into the WorkflowActionHistory table, in the workflow's companion data. The three parameters to this function are required. The rest of the row's values are computed or inherited from local data.

Type and Usage

Parameters

Takes three parameters:

See Also


wfAdditionalExitCondition

Retrieves the exit condition that has been defined for the current step.

Type and Usage

Output

Returns the exit condition as a string.

Example

The following code in the IdcHomeDir/resources/core/templates/workflow_info.htm template page is used to display the exit condition on the Workflow Step Information page:

<$wfDisplayCondition(dWfName, currentStepName, "wfAdditionalExitCondition")$>

Typical exit condition output for this variable would look like:

dSecurityGroup like "Secure"

wfAddUser

Adds a user, alias, or workflow token to the list of reviewers for a workflow step. This function can only be used inside a token.

Type and Usage

Parameters

Takes two parameters:

Example

Adds the user mjones as a reviewer:

<$wfAddUser("mjones", "user")$>

Adds the original author token and the hr alias as reviewers:

<$wfAddUser(dDocAuthor, "user")$>
<$wfAddUser("hr", "alias")$>

wfComputeStepUserList

Computes the list of users from the current step in the workflow.

Type and Usage

Output

Returns a comma-delimited list of users.

See Also


wfCurrentGet

Retrieves a local state value from the companion file.

Type and Usage

Parameters

The only parameter is the key.

Output

Returns the local state value from the companion file.

Example

Returns the value of the local key <step_name>@<workflow_name>.myKey:

<$wfCurrentGet("myKey")$>

See Also


wfCurrentSet

Sets the local state value of a key in the companion file.

Type and Usage

Parameters

Takes two parameters:

Example

Sets the key <step_name>@<workflow_name>.myKey to myValue:

<$wfCurrentSet("myKey", "myValue")$>

See Also


wfCurrentStep

Retrieves the name of a step relative to the current step.

Type and Usage

Parameters

The only parameter is an integer that represents the number of steps relative to the current step.

Output

Example

Returns the current step name:

<$wfCurrentStep(0)$>

Returns the previous step name:

<$wfCurrentStep(-1)$>

Returns the next step name:

<$wfCurrentStep(1)$>

To actually move to the next step you must set up a jump, as in this example:

<$wfSet("wfJumpName", "move to next step")$> 
<$wfSet("wfJumpTargetStep", wfCurrentStep(1))$> 
<$wfSet("wfJumpEntryNotifyOff", "0")$>

wfDisplayCondition

Retrieves the exit condition for a workflow step.

Type and Usage

Parameters

Takes three parameters:

Output

Returns the exit condition expression.

Example

The following code in the IdcHomeDir/resources/core/templates/workflow_info.htm template page is used to display the exit condition on the Workflow Step Information page:

<$wfDisplayCondition(dWfName, currentStepName, "wfAdditionalExitCondition")$>

where:


wfExit

Exits a workflow step. This function moves the revision to a particular step in a workflow according to the function parameters and resets the parent list information. To completely exit a workflow, use wfExit(100,100) or any parameters that ensure that the revision returns to the parent workflow and then gets moved past the last step in that workflow.

Type and Usage

Parameters

Takes two parameters:

Example

Exits to the parent step in the workflow:

<$wfExit(0,0)$>

Returns to the previous jump step:

<$wfExit(1,0)$>

Returns to the previous jump step and moves to the next step in that workflow:

<$wfExit(1,1)$>

wfGet

Retrieves a state value from the companion file.

Type and Usage

Parameters

The only parameter is the state key.

Output

Returns the state value from the companion file.

Example

Returns the current jump name:

<$wfGet("wfJumpName")$>

See Also


wfGetStepTypeLabel

This function takes an internal workflow step type value and turns it into a human readable label. For example, :C:CA:CE: is the three states :C: (contribution), :CA: (autocontribute or original author step) and :CE: (Edit revision). Applying the Idoc Script function the label might become "Auto Contributor, Edit Revision".

Here are the possible current states.

States Description
:CA: Auto contribution step or step that occurs before all administrator defined workflow steps ("original author handles document rejection").
:CE: Edit current revision. All edits replace current revision.
:CN: Create new revision. All edit create new revision.
:R: Review. Document can be approved or rejected.
:C: Contribution. The document can be edited.

A workflow document step state has all the states that are true for it combined as a single fields with multiple values separated by colons (:) (redundant colons are eliminated). So a contributor/reviewer step that creates new revisions would have the state :R:C:CE:. Order does not matter. But :C: must be present even though it can be presumed by the presence of :CE: (:CE: also implies that the step is a contributor step). The value :C: accurately describes one capability of the current workflow step and the Oracle WebCenter Content Server system does not chase implication rules (:CE: -> :C:) so the Oracle WebCenter Content Server system will see the absence of :C: (even with :CE: present) as a statement that the workflow step does not allow core contributor types of activities (such as checkout or undo checkout).

Type and Usage

Parameters

The only parameter is the internal workflow step type value.

Example

<$wfGetStepTypeLabel(stepType)$>

wfIsFinishedDocConversion

Indicates if the document will not be in GENWWW after the current action finishes.

If this Idoc Script function returns true, the conversion process has finished and the content item is no longer in GENWWW.

Type and Usage

Output

Example

<$wfIsFinishedDocConversion()$>

wfIsNotificationSuppressed

Returns TRUE if this workflow is currently suppressing all workflow notifications for this particular workflow event. Suppression includes notification into both the workflow in queue and e-mail until either the current action is ended or the wfSetSuppressNotification function is used to re-enable notification.

Suppression of notifications is temporary. If notification is enabled or allowed to remain on for a later workflow action, all notifications that were not sent out for the current step are then sent out and workflows in queues are appropriated updated.

Type and Usage

Output

Example

<$wfIsNotificationSuppressed()$>

See Also


wfIsReleasable

Indicates if the document is released as far as the workflow is concerned. The document may be still in GENWW or DONE, but if this Idoc Script function returns true, then the workflow is not preventing the release of the document. If it returns false, then the document will not be released until the workflow allows it to be released. This Idoc Script function takes no parameters. It evaluates the active release state value for any document info that may be present (in Idoc Script terms it checks if #active.dReleaseState is not the value E).

Type and Usage

Output

Example

<$wfIsReleasable()$>

wfJumpEntryNotifyOff

Turns the jump entry notification on and off.

Type and Usage

Output

Returns TRUE or FALSE.

Example

The following code sets the step entry notification to 0, which means that reviewers will be notified upon jump entry:

<$wfSet("wfJumpEntryNotifyOff","0")$>

wfJumpMessage

Defines a message that will be included in the notification e-mail that is sent to users when a jump is entered.

Type and Usage

Output

Returns the message as a string.

Example

The following code includes the message This is the message text in the e-mail message that notifies users upon jump entry:

<$wfSet("wfJumpMessage","This is the message text")$>

See Also


wfJumpName

Retrieves the name of the current jump.

Type and Usage

Output

Returns the jump name as a string.

Example

The following code sets the name of the current jump to MyJump:

<$wfSet("wfJumpName","MyJump")$>

wfJumpReturnStep

Retrieves the name of the step in the parent workflow that the revision returns to upon exiting a workflow after the current jump.

Type and Usage

Output

Returns the step name as a string.

Example

The following code sets the return step to be the next step in the parent workflow:

<$wfSet("wfJumpReturnStep",wfCurrentStep(1))$>

wfJumpTargetStep

Retrieves the name of the step the revision will jump to if the condition is met.

The target step can be referred to symbolically (such as wfCurrentStep(1)) or explicitly (such as MyStep@MyWorkflow). It is strongly recommended that you use symbolic references in step event scripts. They make the script easier to modify and reuse.

Type and Usage

Output

Returns the step name as a string.

Example

The following code sets the target step explicitly. When the jump criteria is met, the revision jumps to a step named step_1 in the Marketing workflow:

<$wfSet("wfJumpTargetStep","step_1@Marketing")$>

The following code sets the target step symbolically. When the jump criteria is met, the revision jumps to the first step in the current workflow:

<$wfSet("wfJumpTargetStep",WfStart)$>

wfLoadDesign

This function is used to obtain information about the existing steps in a workflow or about exit conditions in a workflow.

This function loads the IntradocDir/data/workflow/design/workflowname.hda file and returns a ResultSet containing design information for a workflow. workflowname corresponds to the value for the dWfName variable, usually available on workflow pages, email templates, and jump scripts.

Type and Usage

Parameters

Takes one parameter, the name of the workflow.

Output

Returns the information as a ResultSet.

Example

<$wfLoadDesign(WorkflowName)$>

wfMailSubject

Defines the subject line of a workflow e-mail notification.

If no subject line is specified, the e-mail will use the default subject for the type of notification (review, reject, or workflow started).

Idoc Script can be included in the subject string.

Type and Usage

Output

Returns the subject line as a string.

Example

Notifies the original author with the subject line "Content ID has been released":

<$wfMailSubject="File <$dDocName$> has been released"$>
<$wfNotify(dDocAuthor, "user")$>

See Also


wfMessage

Defines a message that will be included in a workflow e-mail notification.

If no message is specified, the e-mail will use the default message for the type of notification (review, reject, or workflow started).

Idoc Script can be included in the message string.

Type and Usage

Output

Returns the message as a string.

Example

Notifies the original author with the message "Content ID has been released":

<$wfMessage="File <$dDocName$> has been released"$>
<$wfNotify(dDocAuthor, "user")$>

See Also


wfNotify

Sends an e-mail message to a specified user, alias, or workflow token.

The wfMailSubject and wfMessage variables can be set to customize the notification message.

Type and Usage

Parameters

Takes two parameters and an optional third parameter:

Example

Notifies the original author:

<$wfNotify(dDocAuthor, "user")$>

Notifies all users in the myAlias alias, using the IdcHomeDir/resources/core/templates/reject_mail.htm file as a template:

<$wfNotify("myAlias", "alias", "WF_REJECT_MAIL")$>

See Also


wfParentList

Retrieves a list (parent list) of the workflow steps that the revision has visited. This tells the system where jumps occurred and how to unwind the steps during an error, a reject, or an exit.

This variable can be used to create conditional statements, but it should not be hard-coded or altered.

If the parent list is unwound due to an error, reject, or exit, steps are removed from the list, so the parent list may not reflect the complete step history.

The parent list is global, and is not localized with a step name.

Steps in the parent list are listed with the most recent step first. Steps are separated with a pound sign (#). An asterisk before a step name indicates that it is a jump step. For example:

Step_B@Workflow_2#*Step_A@Workflow_2#Step_1@Workflow_1

Type and Usage

Output

Returns the parent list as a string.

Example

One use for the parent list is to simulate the jumps that a content item has visited when you are testing a workflow script. For example, on the Test tab or the Edit Script screen, selecting a content item and clicking Load Item's Workflow State could result in the following line:

wfParentList=step_1@Marketing#contribution@Marketing

wfReleaseDocument

Causes a workflow to release all outstanding document revisions for a document that are currently being locked by the workflow. Such released revisions are free to be evaluated by the indexing engine and one of the released revisions may be full-text indexed as a result.

This function can only be used in the context of the evaluation of Idoc Script for a workflow step going through a workflow event. The function will have no effect if the document has already been released by the workflow. Note that this function does not cause the document to exit workflow.

Any new revision that is created for the document will be back in a "locked" (unreleasable) state. In other words, this function releases current revisions but has no implications for any new revision that may be created. This function takes no parameters and returns no result. It acts on the current active workflow document.

Type and Usage

Example

<$wfReleaseDocument()$> 

wfSet

Sets a key with a particular value in the companion file.

Type and Usage

Parameters

Takes two parameters:

Example

Sets the key wfJumpName to MyJump:

<$wfSet("wfJumpName", "MyJump")$>

See Also


wfSetSuppressNotification

Sets an internal flag indicating if workflow notification will be sent out during the current action (check in, update, resubmit, and so on).

The suppression is on both e-mail and updates to the workflow in queue. An additional use for this function is to suppress workflow notification until after a document has been converted. This prevents a document from advancing out of the auto-contributor workflow step when the document finishes a conversion.

Type and Usage

Parameters

Takes one parameter, the internal flag. If set to 1 (TRUE), notifications are suppressed. If set to 0 (FALSE), notifications are not suppressed.

Example

<$wfSetSuppressNotification(1)$>

See Also


WfStart

Sends the revision to the first step in the current workflow. Note that this variable begins with an uppercase W.

Type and Usage

Example

Sets the target step for a jump to restart the workflow:

<$wfSet("wfJumpTargetStep",WfStart)$>

wfUpdateMetaData

Defines a metadata value for the current content item revision in a workflow.

The wfUpdateMetaData function can be used only for updating custom metadata fields. You cannot use this function to update standard, predefined fields

Type and Usage

Parameters

Takes two parameters:

Example

Defines "This is my comment." as the value of the Comments field:

<$wfUpdateMetaData("xComments", "This is my comment.")$>

WorkflowDir

Defines the path to the workflow directory, which contains workflow data.

Default is IntradocDir/data/workflow.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

WorkflowDir=c:/workflow_info/

WorkflowIntervalHours

Defines the time between workflow update cycles, in hours.

The update event scripts for any revisions in a workflow are executed at this interval.

Default is 1 hour.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

WorkflowIntervalHours=2

XMLEncodingMode

Used to specify international characters in URLs in the browser used for the Oracle WebCenter Content Server system.

Setting this variable to FULL may be useful in the following instances:

Default is PARTIAL.

Type and Usage

Location

IntradocDir/config/config.cfg

Example

Used as a configuration entry:

XMLEncodingMode=full