Skip Headers
Oracle® Fusion Middleware System Administrator's Guide for Content Server
11g Release 1 (11.1.1)
E10792-01
  Go To Documentation Library
Library
Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
 
Next
Next
 

A.1 System Properties and Settings Interface

The following screens are used to configure Content Server system properties and settings:

A.1.1 Admin Server Interface

The following screens are available when using the Admin Server.

A.1.1.1 Admin Server Page

The Admin Server page is used to view server status, manage components, and to access Content Server system properties, log, and audit information.

To access the Admin Server page:

  1. Log in as a user with the Oracle WebLogic Server 'sysmanager' role.

  2. Click the Administration tray in the portal navigation bar. The Administration selections are displayed.

  3. Click Admin Server.

Surrounding text describes Content Admin Server screen.
Element Description
Server Status link Displays the current Content Server status on the Admin Server home page. Use the Oracle WebLogic Server Administration Console to start, stop, or restart the content server.
Component Manager link Displays the Component Manager Page. Use this page to view, enable, and disable content server components. From this page you also can access the Advanced Component Manager Page.
General Configuration link Displays the Admin Server: General Configuration Page. Use this page to view or modify general content server configuration.
Content Security link Displays the Admin Server: Content Security Page, which contains the same information as shown on the System Properties: Content Security Tab. Use this page to view or modify content security configuration.
Internet Configuration link Displays theAdmin Server: Internet Configuration Page, which contains the same information as shown on the System Properties: Internet Tab. Use this page to view or modify internet configuration for the content server.
View Admin Output link Displays the Admin Server Output Page. Use this page to view console output.
View Server Logs link Displays the list of content server log files.
View Providers link Displays the Providers Page.
System Audit Information Displays the System Audit Information Page, which provides general information about the content server, plus information on localization, tracing sections, cache, configuration entry, and component reports..

A.1.1.2 Admin Server Status Page

The Server Status page displays the current status of the Content Server; for example, Running. To access this page, click the Server Status link on the Admin Server Page.

Content Admin Server Status screen
Element Description
Current Status Displays the current status of the content server.
Home Page button Displays the content server Home page.
Administration button Displays the content server Administration page, which shows icons and names for administrative functions.

A.1.1.3 Admin Server Output Page

The Admin Server Output page displays the Java output of the Admin Server, which includes status and error messages for troubleshooting. To access this page, click the View Admin Output link on the Admin Server Page.

Admin Server Output page
Element Description
Refresh Page button Refreshes the output messages.
Clear button Clears the output messages. The output will not be displayed until the Content Admin service is restarted.
Output messages Shows status and error messages for the Admin Server.

A.1.1.4 Administration Page

The Administration page displays icons and names which are links to Content Server administration functions. To access this page, click Administration on the Admin Server Status Page.

Surrounding text describes Administration page.
Element Description
Content Server Logs link Displays the Content Server Logs Screen.
Archiver Logs link Displays the Archiver Log Screen.
Actions for Instance link Displays current actions for the Content Server instance.
Admin Applets link Displays the Admin Applets screen, which provides links for several administration applications.
Configuration for Instance link Displays the Configuration Information Page.
System Audit Information link Displays the System Audit Information Page.
Providers link Displays the Providers Page.
Filter Administration link Displays the Configure Web Server Filter Page.
Oracle Query Optimizer link Displays the Oracle Query Optimizer Page.
File Store Provider link Displays the FileStore Provider Information Page.
Connection Passwords link Displays the Proxied Connection Authentication/Authorization Information Screen.
Credential Maps link Displays the Credential Maps Screen.
Config Migration Admin link Displays the Config Migration Admin Screen.
Admin Server link Displays the Admin Server Page.
Environment Packager link Displays the Environment Packager Page.
Conversion Options link Displays Inbound Refinery conversion options. For details, see Oracle Fusion Middleware Administrator's Guide for Conversion.
Conversion Job Status link Displays Inbound Refinery conversion job status information. For details, see Oracle Fusion Middleware Administrator's Guide for Conversion.
IBR Provider Status link Displays Inbound Refinery provider status information. For details, see Oracle Fusion Middleware Administrator's Guide for Conversion.

A.1.2 System Properties Configuration Interface

The following screens are used to configure system properties for Content Server:

A.1.2.1 System Properties Page

The System Properties utility can be used to configure the system options and functionality of the content server. It can be started only as a standalone application from the computer where the content server is installed.

Surrounding text describes System Properties screen.
Element Description
Options tab Used to set optional functionality for the content server.
Content Security tab Used to set options related to content item security.
Internet tab Used to set options related to content server interaction with web entities
Database tab Used to set database options.
Server tab Used to set optional functionality for the content server.
Localization tab Used to set localization options.
Paths tab Used to set content server directory paths.
OK button Saves the changes and closes the System Properties screen. You must restart the content server for any changes to take effect.
Cancel button Closes the System Properties screen without saving any changes.

A.1.2.2 General Options Configuration

You can set general options on the System Properties: Options Tab or on the Admin Server: General Configuration Page.

You must restart the Content Server for any configuration changes to take effect.

A.1.2.2.1 System Properties: Options Tab

You can set general options on the System Properties: Options Tab. You can run this application in standalone mode from the computer where the content server is installed. The method required to start these programs differs slightly between Windows and UNIX installations.

Surrounding text describes System Properties Options tab.
Element Description
Allow override format on check in check box

(IsOverrideFormat)

Clear: Users cannot select the format of a document during checkin. This is the default.

Selected: Users can select the format of a document during checkin. This is useful in the following situations:

  • When an application's default extension is not used for a file name. For example, a Microsoft Word document named customer.ltr does not have the default application extension .doc, but a contributor could select Microsoft Word Document from the Formats list on the checkin page to tell the content server how to convert the file.

  • When the user must decide how the file should be converted and indexed. For example, say you have set Corel WordPerfect documents to be passed through as text files. If a contributor leaves the Format option on the checkin page as use default, the file is converted to text and full-text indexed automatically. If the contributor selects Corel WordPerfect Document, the file is passed through in its native format and is not full-text indexed.

Enable download applet check box

(DownloadApplet)

Selected: Users can select multiple files to check out or download at the same time. See the Oracle Fusion Middleware User's Guide for Content Server for details.

Clear: Users cannot check out or download multiple files. This is the default.

If the upload or download applet is enabled in the System Properties application or Admin Server, users can enable and disable the applet individually on their User Profile page. If an applet is disabled at the system level, the applet field is not displayed on User Profile pages.

Enable upload applet check box

(MultiUpload)

Selected: Users can check in multiple files as a single Zip file. For more information, see the Oracle Fusion Middleware User's Guide for Content Server.

Clear: Users cannot check in multiple files. This is the default.

Enable search keyword highlighting check box

(EnableDocumentHighlight)

Selected: All full-text search terms are highlighted in returned PDF, HTML, and text documents. This is the default.

Clear: Full-text search terms are not highlighted. This can shorten the time required to view a file from the Search Results page.

Enable Enterprise Search on Standard query pages check box

(EnterpriseSearchAsDefault)

Selected: Enterprise Search fields are displayed on search pages. The Enterprise Search add-on module must be purchased and installed.

Clear: Enterprise Search fields are not displayed on search pages. This is the default.

Automatically assign a Content ID on check in check box

(IsAutoNumber)

Selected: Content IDs are generated automatically as six-digit, sequential numbers.

Clear: A Content ID must be entered by the user during checkin. This is the default.

Auto Name/Number Prefix field

(AutoNumberPrefix)

If automatic Content ID generation is enabled, the string specified in this field is added as a prefix to the six-digit, sequential number.
Major Revision Label Sequence field

(MajorRevSeq)

Specifies how the first number or letter in a revision number is incremented.
Minor Revision Label Sequence field

(MinorRevSeq)

Specifies how the optional second number or letter in a revision number is incremented.
Enable Java Server Page (Jsp) check box

(IsJspServerEnabled)

Selected: Internal JSP support is enabled in the content server.

Clear: Internal JSP support is disabled.

See the Java Server Page and JavaBean Guide for more information.

This check box is displayed on the Admin Server General Configuration page, but not on the System Properties Options tab. See "System Properties: Server Tab".

Jsp Enabled Groups field

(JspEnabledGroups)

Specifies the security groups that are enabled for internal JSP support.

See the Java Server Page and JavaBean Guide for more information.

This field is displayed on the Admin Server General Configuration page, but not on the System Properties Options tab. See "System Properties: Server Tab".

Additional Configuration Variables field

(N/A)

Used to edit variables in the content server configuration file.
  • Changes you make in this field will be reflected in the IntradocDir/config/config.cfg file when the content server is restarted.

  • Placing a # symbol at the beginning of a line comments out that line.


A.1.2.2.2 Admin Server: General Configuration Page

To access this page, click Admin Server from the Administration tray in the portal navigation bar. Click the content server instance you want to access and select General Configuration from the Options for instance menu.

This page provides access to the same information as provided in the System Properties: Options Tab.

In the following table, the term in parentheses is the corresponding configuration setting defined in the IntradocDir/config/config.cfg file.

If you plan to use the Batch Loader to update and insert a large number of files on your content server system simultaneously, you must create a batch load file. Two of the optional parameters that you can include in your batch load file are the primaryOverrideFormat and alternateOverrideFormat. However, these options will only work as parameters in the batch load file if you enable the IsOverrideFormat configuration variable. You can set this variable in the System Properties application.

Admin Server General Configuration screen
Element Description
Allow override format on check in check box

(IsOverrideFormat)

Clear: Users cannot select the format of a document during checkin. This is the default.

Selected: Users can select the format of a document during checkin. This is useful in the following situations:

  • When an application's default extension is not used for a file name. For example, a Microsoft Word document named customer.ltr does not have the default application extension .doc, but a contributor could select Microsoft Word Document from the Formats list on the checkin page to tell the content server how to convert the file.

  • When the user must decide how the file should be converted and indexed. For example, say you have set Corel WordPerfect documents to be passed through as text files. If a contributor leaves the Format option on the checkin page as use default, the file is converted to text and full-text indexed automatically. If the contributor selects Corel WordPerfect Document, the file is passed through in its native format and is not full-text indexed.

Enable download applet check box

(DownloadApplet)

Selected: Users can select multiple files to check out or download at the same time. See the Oracle Fusion Middleware User's Guide for Content Server for details.

Clear: Users cannot check out or download multiple files. This is the default.

If the upload or download applet is enabled in the System Properties application or Admin Server, users can enable and disable the applet individually on their User Profile page. If an applet is disabled at the system level, the applet field is not displayed on User Profile pages.

Enable upload applet check box

(MultiUpload)

Selected: Users can check in multiple files as a single Zip file. See the Oracle Fusion Middleware User's Guide for Content Server.

Clear: Users cannot check in multiple files. This is the default.

Enable search keyword highlighting check box

(EnableDocumentHighlight)

Selected: All full-text search terms are highlighted in returned PDF, HTML, and text documents. This is the default.

Clear: Full-text search terms are not highlighted. This can shorten the time required to view a file from the Search Results page.

Enable Enterprise Search on Standard query pages check box

(EnterpriseSearchAsDefault)

Selected: Enterprise Search fields are displayed on search pages. The Enterprise Search add-on module must be purchased and installed.

Clear: Enterprise Search fields are not displayed on search pages. This is the default.

Enable Accounts check box Selected: Accounts are functional on the content server.

Clear: Accounts are not functional on the content server.

Automatically assign a document name on check in check box

(IsAutoNumber)

Selected: Content IDs are generated automatically as six-digit, sequential numbers.

Clear: A Content ID must be entered by the user during checkin. This is the default.

Auto Name/Number Prefix field

(AutoNumberPrefix)

If automatic Content ID generation is enabled, the string specified in this field is added as a prefix to the six-digit, sequential number.
Major Revision Label Sequence field

(MajorRevSeq)

Specifies how the first number or letter in a revision number is incremented.
Minor Revision Label Sequence field

(MinorRevSeq)

Specifies how the optional second number or letter in a revision number is incremented.
Enable Java Server Page (Jsp) check box

(IsJspServerEnabled)

Selected: Internal JSP support is enabled in the content server.

Clear: Internal JSP support is disabled.

See the Java Server Page and JavaBean Guide for more information.

This check box is displayed on the Admin Server General Configuration page, but not on the System Properties Options tab. See "System Properties: Server Tab".

Jsp Enabled Groups field

(JspEnabledGroups)

Specifies the security groups that are enabled for internal JSP support.

See the Java Server Page and JavaBean Guide for more information.

This field is displayed on the Admin Server General Configuration page, but not on the System Properties Options tab. See "System Properties: Server Tab".

Additional Configuration Variables field

(N/A)

Used to edit variables in the content server configuration file.
  • Changes you make in this field will be reflected in the IntradocDir/config/config.cfg file when the content server is restarted.

  • Placing a # symbol at the beginning of a line comments out that line.


A.1.2.3 Content Security Configuration

You can set content security options on the System Properties: Content Security Tab or on the Admin Server: Content Security Page.

You must restart the Content Server for any configuration changes to take effect.

A.1.2.3.1 System Properties: Content Security Tab

You can set content security options on the System Properties: Content Security Tab. You can run this application in standalone mode from the computer where the content server is installed. The method required to start these programs differs slightly between Windows and UNIX installations.

System Properties Content Security tab
Element Description
Allow get copy for user with read privilege check box

(GetCopyAccess)

Selected: Users with only Read permission to a content item's security group can get a copy of the native file.

Clear: Users with only Read permission to a content item's security group cannot get a copy of the native file.

Allow only original contributor to check out check box

(ExclusiveCheckout)

Selected: Only the Author or a user with Admin permission to a content item's security group can check out the content item.

Clear: Any user with Write permission to a content item's security group can check out the content item.

Allow author to delete revision check box

(AuthorDelete)

Selected: The Author of a content item can delete the content item, even if they do not have Delete permission to the content item's security group.

Clear: All users must have Delete permission to a content item's security group to delete the content item.

Show only known accounts check box

(ShowOnlyKnownAccounts)

Selected: Only predefined accounts appear in the Accounts option list on checkin and search pages.

Clear: User-defined accounts and predefined accounts appear in the Accounts option list on checkin and search pages.


A.1.2.3.2 Admin Server: Content Security Page

You can set content security options on the Admin Server: Content Security Configuration Page.

To access this page, click Admin Server from the Administration tray in the portal navigation bar. Select Content Security from the Options for instance menu.

This page provides access to the same information as provided on the System Properties: Content Security Tab.

In the following table, the term in parentheses is the corresponding configuration setting defined in the IntradocDir/config/config.cfg file.

Admin Server Content Security Options screen
Element Description
Allow get copy for user with read privilege check box

(GetCopyAccess)

Selected: Users with only Read permission to a content item's security group can get a copy of the native file.

Clear: Users with only Read permission to a content item's security group cannot get a copy of the native file.

Allow only original contributor to check out check box

(ExclusiveCheckout)

Selected: Only the Author or a user with Admin permission to a content item's security group can check out the content item.

Clear: EuAny user with Write permission to a content item's security group can check out the content item.

Allow author to delete revision check box

(AuthorDelete)

Selected: The Author of a content item can delete the content item, even if they do not have Delete permission to the content item's security group.

Clear: All users must have Delete permission to a content item's security group to delete the content item.

Show only known accounts check box

(ShowOnlyKnownAccounts)

Selected: Only predefined accounts appear in the Accounts option list on checkin and search pages.

Clear: User-defined accounts and predefined accounts appear in the Accounts option list on checkin and search pages.


A.1.2.4 Internet Information Configuration

You can set Internet options on the System Properties: Internet Tab or on the Admin Server: Internet Configuration Page.

You must restart the content server for any configuration changes to take effect.

A.1.2.4.1 System Properties: Internet Tab

You can set Internet options on the System Properties: Internet Tab. You can run this application in standalone mode from the computer where the content server is installed. The method required to start these programs differs slightly between Windows and UNIX installations.

Surrounding text describes System Properties Internet tab
Element Description
HTTP Server Address field*

(HttpServerAddress)

The name of the web server.

For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

Mail Server field

(MailServer)

The e-mail server used to send e-mail notifications from the content server. This generally takes the form of mail.company.com. If applicable, make sure to allow for sending mail through a firewall.
Administrator Mail Address field

(SysAdminAddress)

The e-mail address that the content server uses to send e-mail notifications. This address will receive returned messages if delivery failures occur.
SMTP Port field*

(SmtpPort)

The port used for SMTP communications. This is typically 25, but consult your network system administrator for any changes.

For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

Http Relative Web Root field*

(HttpRelativeWebRoot)

The relative web root that is used by the web server to resolve URLs to files in the IntradocDir/weblayout/ directory.

For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

Use Secure Sockets Layer check box*

(UseSSL)

Selected: A Secure Sockets Layer (SSL)-enabled web server is being used.

Clear: A Secure Sockets Layer (SSL)-enabled web server is not being used.

For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.


A.1.2.4.2 Admin Server: Internet Configuration Page

You can set Internet options from the Admin Server: Internet Configuration page.

To access this page, click Admin Server from the Administration tray in the portal navigation bar. Select Internet Configuration from the Options for instance menu.

This page provides access to the same information as provided on the System Properties: Internet Tab.

In the following table, the term in parentheses is the corresponding configuration setting defined in the IntradocDir/config/config.cfg file.

Admin Server Internet Configuration screen
Element Description
HTTP Server Address field*

(HttpServerAddress)

The hostname and port of the web server.

For security reasons, this field cannot be changed using the Admin Server. You must change the field using the standalone application.

Mail Server field

(MailServer)

The e-mail server used to send e-mail notifications from the content server. This generally takes the form of mail.company.com. If applicable, make sure to allow for sending mail through a firewall.
Administrator Mail Address field

(SysAdminAddress)

The e-mail address that the content server uses to send e-mail notifications. This address will receive returned messages if delivery failures occur.
SMTP Port field*

(SmtpPort)

The port used for SMTP communications. This is typically 25, but consult your network system administrator for any changes.

For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

Http Relative Web Root field*

(HttpRelativeWebRoot)

The relative web root that is used by the web server to resolve URLs to files in the IntradocDir/weblayout/ directory.

For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.

Use Secure Sockets Layer field*

(UseSSL)

True: A Secure Sockets Layer (SSL)-enabled web server is being used.

False: A Secure Sockets Layer (SSL)-enabled web server is not being used.

For security reasons, this field cannot be changed from the Admin Server. You must change the field using the standalone application.


A.1.2.5 System Properties: Database Tab

You can set JDBC (Java Database Connectivity) configuration options on the System Properties: Database Tab. For security reasons, the Admin Server cannot be used to configure the database. You must use the standalone application to configure the database.

You must restart the content server for any configuration changes to take effect.

In the following table, the term in parentheses is the corresponding configuration setting defined in the IntradocDir/config/config.cfg file.

Surrounding text describes System Properties Database tab.
Element Description
Use Java Database Connectivity check box

(IsJdbc)

Selected: JDBC is enabled, and the options are active. This is the default.

Clear: JDBC is disabled.

JDBC options

(N/A)

The type of database driver.
  • For all options except Other JDBC Driver, the JDBC Driver Name and JDBC Connection String are entered automatically.

  • For the Other JDBC Driver option, you must enter the correct JDBC Driver Name and JDBC Connection String.

Enable database preserve case check box

(DatabasePreserveCase)

Selected: The database is case sensitive (such as Oracle or Informix).

Clear: The database is not case sensitive.

Specify Database Driver Classpath check box Selected: A database driver classpath must be specified in the Database Driver Classpath field to support a database connection.

Clear: No database driver classpath is required.

Database Driver Classpath field The classpath for the database driver.
JDBC Driver Name field

(JdbcDriver)

The name of the JDBC driver.
  • For all options except Other JDBC Driver, the correct name is entered automatically.

  • For the Other JDBC Driver option, you must enter the correct driver name.

JDBC Connection String field

(JdbcConnectionString)

The connection string for the JDBC driver.
  • For all options except Other JDBC Driver, the correct connection string is entered automatically.

  • For the Other JDBC Driver option, you must enter the correct connection string.

The connection string format is JDBC:ODBC:name, where name is the System Data Source Name. To find this name on a Windows system, perform the following steps:

  1. Click Programs in the Start menu

  2. Click Administrative tools in the Programs menu

  3. Click Data Sources in the Administrative tools, to open ODBC screen.

  4. Select the system DSN tab on the ODBC Data Source Administrator screen. The System Data Source Names are displayed on this tab

JDBC User Name field

(JdbcUser)

The user name that owns the tables inside the database.
JDBC User Password field

(JdbcPassword)

The password for the user name that owns the tables inside the database.

A.1.2.6 System Properties: Server Tab

You can set content server options on the System Properties: Server Tab. For security reasons, the Admin Server cannot be used to configure these options. You must use the standalone application to configure options.

You must restart the content server for any configuration changes to take effect.

In the following tables, the term in parentheses is the corresponding configuration setting defined in the IntradocDir/config/config.cfg file.

Surrounding text describes System Properties Server tab.
Element Description
System Locale list

(SystemLocale)

Specifies how the content server handles several language-specific issues such as the language of the user interface, stemming rules, sort order, and date/time format.
System Timezone list

(SystemTimeZone)

The time zone in which the content server system is located. The specified time zone can be used to present times relative to other time zones, such as correcting for Daylight Savings Time, or presenting the date and time of a content item on a content server in North America to users in Europe.

If the Detect timezone automatically option is selected, a time zone is not specified in the configuration file, and the content server uses the time zone set for the computer's operating system.

Instance Menu Label field

(InstanceMenuLabel)

The instance name that is displayed in the Windows Start menu.
Instance Description field

(InstanceDescription)

Not currently used.
IP Address Filter field

(SocketHostAddressSecurity Filter)

Restricts access to the content server to computers with a specified IP address.
  • By default, this field is pre-filled with the IP address of the local host (127.0.0.1).

  • You can specify multiple IP addresses, separated by pipes ( | ). Make sure that there are no spaces on either side of the pipe character. (For example, 127.0.0.1|10.10.50.143)

  • You can use wildcards in this field, * for zero or many characters, and ? for any one character. (For example, 10.10.3.*)

  • Generally, use only the IP Address Filter field or Hostname Filter field, not both. (IP Address Filter is more commonly used.)

Proxy Password field Specifies the password for the proxy.
Confirm Password field Confirms the password.
Execute Java Server Page (JSP) check box

(IsJspServerEnabled)

Selected: Internal JSP support is enabled in the content server.

Clear: Internal JSP support is disabled.

See the Java Server Page and JavaBean Guide for more information.

In the Admin Server, this check box is displayed on the Admin Server: General Configuration Page.

JSP Enabled Groups field

(JspEnabledGroups)

Specifies the security groups that are enabled for internal JSP support.

See the Java Server Page and JavaBean Guide for more information.

In the Admin Server, this field is displayed on the Admin Server: General Configuration Page.


A.1.2.7 System Properties: Paths Tab

You can use the System Properties: Paths Tab to change the location of the help browser, Java classpath, and the shared directory path. For security reasons, the Admin Server cannot be used to configure the path options. You must use the standalone application for this configuration.

You must restart the content server for any configuration changes to take effect.

In the following table, the term in parentheses is the corresponding configuration setting defined in the DomainHome/ucm/cs/bin/intradoc.cfg file.

Surrounding text describes System Properties Paths tab.
Element Description
Browser Executable Path field

(WebBrowserPath)

The location of the browser executable that will be used to display the online help from the standalone Overview of Administration Utilities and Applets.
  • For Windows 2000 systems, the default is c:/Program Files/Internet Explorer/iexplore.exe.

  • For UNIX systems, the path for the web browser is requested during installation.

Browse button

(N/A)

Used to navigate to and select the executable file for the Help browser.
Custom Java Classpath field

(BASE_JAVA_CLASSPATH_custom)

Specifies the path to the Java class files.
  • By default, the CLASSPATH points at classes/, shared/classes/, and shared/classes/server.zip.

  • If an Oracle or Informix database is used, the CLASSPATH will include a JDBC driver zip file, such as shared/classes/classes111.zip.

Shared Directory Path field

(IdcHomeDir)

Defines the path to the shared directory.
  • This directory contains shared files for the content server, such as resource files, template files, and binaries such as mkvdk.

  • If the Inbound Refinery is installed, this directory contains the conversion engines, and all Inbound Refinery temp work is done in this directory and its subdirectories.

  • The default is IdcHomeDir/resources/.


A.1.3 Indexing and Search Content Interface

The following screens are used when working with the search index, configuring zone text fields, and searching content using the Oracle Query Optimizer component:

A.1.3.1 Repository Manager: Indexer Tab

The Indexer tab of the Repository Manager is used to monitor, run, and configure Indexer update cycles and collection rebuild cycles. It also provides access to the OracleTextSearch feature for fast rebuilds. To access the Repository Manager application, click the Administration tray in the portal navigation bar, then Admin Applets, then Repository Manager. To access the Indexer functions, click the Indexer tab on the Repository Manager window.

For more details about the Repository Manager administration application, see "Managing Repository Content" in the Oracle Fusion Middleware Application Administrator's Guide for Universal Content Management.

Surrounding text describes Repository Manager Indexer tab.
Element Description
Automatic Update Cycle pane Incrementally updates the index database automatically approximately every five minutes, regardless of whether an event (such as file checkin) has triggered the Indexer.
Collection Rebuild Cycle pane The search index is entirely rebuilt, and the old index collection is replaced with a new index collection when the rebuild is successfully completed.
State field The current place in the indexing cycle:

Initialization: The indexing cycle is being initialized.

Adding to collection...: Revisions are being indexed.

Finished: The indexing cycle is completed or has been canceled.

Status field The status of the indexing cycle:

Idle: No indexing cycles are in process.

Active: An indexing cycle is currently running.

Interrupted: The indexing cycle was interrupted, either by a suspension or an unexpected event (such as a power, database, or file system failure).

Suspending: The indexing cycle is being suspended.

Cancelling: The indexing cycle is being canceled.

Start Date field The date and time the last indexing cycle started.
Finish Date field The date and time the last indexing cycle finished.
Active Date field If the indexing cycle is currently active, the date and time the cycle became active.
Indexer Counters field Counter values for the current indexing cycle.

Total: The total number of documents indexed.

Full Text: The number of full-text indexed documents.

Meta Only: The number of documents for which only metadata has been indexed.

Delete: The number of documents deleted from the search index.

Start/Restart button Begins the indexing cycle, or restarts a cycle that was suspended or interrupted. Corresponds to the Start index update and Start index rebuild links in the Actions section of the Administration tray. These links enable you to remotely manage indexing functions.
Suspend button Stops the indexing cycle and permits a restart. Corresponds to the Suspend index update and Suspend index rebuild links in the Actions section of the Administration tray. These links enable you to remotely manage indexing functions.
Cancel button Stops the indexing cycle but does not permit a restart. Corresponds to the Cancel index update and Cancel index rebuild links in the Actions section of the Administration tray. These links enable you to remotely manage indexing functions.
Configure button Displays either the Automatic Update Cycle Screen or the Collection Rebuild Cycle Screen, which enable you to adjust the files per batch, checkpoint, and debug level.

A.1.3.2 Automatic Update Cycle Screen

The Automatic Update Cycle screen is used to configure how the Indexer automatically indexes new files and revisions. To access this screen, click Configure in the Automatic Update Cycle pane of the Repository Manager: Indexer Tab.

Surrounding text describes Automatic Update Cycle screen.
Element Description
Content Items Per Indexer Batch field The maximum number of files that the search index will process simultaneously. The default is 25. For example, 25 files are indexed together, then the next 25 files are indexed. However, if one item fails, then the batch is processed again.

Thus, if you set this value to 2000 and a document fails, the entire batch would be reprocessed. This would take longer than if you use the default setting and an item fails. But, if there are no failures in the batch, then setting this value higher accelerates the process.

The only time you would change this setting to one (1) is if you are experiencing problems with the search engine indexing large and complicated files.

Content Items Per Checkpoint field The number of files that will go through all relevant indexing states at a time. You can have multiple batches of files indexed per checkpoint. After the checkpoint is reached, some merging of the collection is done before the next batch is processed.

If this is set to a high value and you try to cancel a rebuild or an update cycle, the Repository Manager does not stop processing until the checkpoint is reached. However, setting the value too low slows down the indexing process.

Indexer Debug Level list The Indexer debug level. The more debug information listed in the server window, the slower the indexing progresses. The following list shows the debug levels from the least to the most debug information:

none: No information for each file access is displayed, and no log will be generated.

verbose: Displays information for each file accessed. Indicates indexed, ignored, or failed, and generates a full report.

debug: Displays the medium level of information, which is specifically functional.

trace: Displays the lowest level of information for each activity performed.

all: Displays the highest level of debug information.

Indexer Auto Updates check box Selected: The index database is updated automatically.

Clear: The index database is not updated automatically.


A.1.3.3 Collection Rebuild Cycle Screen

The Configure Collection Rebuild Cycle screen is used to configure how the Indexer rebuilds the search collection. To access this screen, click Configure in the Collection Rebuild Cycle pane of the Repository Manager: Indexer Tab.

Surrounding text describes Collection Rebuild Cycle screen.
Element Description
Content Items Per Indexer Batch field The maximum number of files that the search index will process simultaneously. The default is 25. For example, 25 files are indexed together, then the next 25 files are indexed. However, if one item fails, then the batch is processed again.

Thus, if you set this value to 2000 and a document fails, the entire batch would be reprocessed. This would take longer than if you use the default setting and an item fails. But, if there are no failures in the batch, then setting this value higher accelerates the process.

The only time you would change this setting to one (1) is if you are experiencing problems with the search engine indexing large and complicated files.

Content Items Per Checkpoint field The number of files that will go through all relevant indexing states at a time. You can have multiple batches of files indexed per checkpoint. After the checkpoint is reached, some merging of the collection is done before the next batch is processed.

If this is set to a high value and you try to cancel a rebuild or an update cycle, the Repository Manager will not stop processing until the checkpoint is reached. However, setting the value too low will slow down the indexing process.

Indexer Debug Level list The Indexer debug level. The more debug information listed in the server window, the slower the indexing progresses. The following list shows the debug levels from the least to the most debug information:

none: No information for each file accessed is displayed.

verbose: Displays information for each file accessed. Indicates indexed, ignored, or failed.

debug: Displays the medium level of information.

trace: Displays the lowest level of information.

all: Displays the highest level of information.

Database and Database Full-Text Search do not support indexer debug levels, so only the none option is displayed if you use a database for search and index.


A.1.3.4 Indexer Rebuild Screen

If you are using OracleTextSearch as your search and indexing engine, when you use the Collection Rebuild Cycle Screen on the Repository Manager: Indexer Tab, you can choose to use the Indexer Rebuild function. Using Indexer Rebuild causes the search engine to add new information to the search collection without requiring a full collection rebuild. It does not cause all the information (metadata and full-text) to be re-indexed.

When you click Start on the Collection Rebuild Cycle Screen, the Indexer Rebuild screen is displayed. To use this function, click OK. To not use this function, clear the Use fast rebuild check box and click OK.

Surround text describes Indexer Rebuild screen.

A.1.3.5 Oracle Query Optimizer Page

The Oracle Query Optimizer utility provides several methods for optimizing queries. To access the Oracle Query Optimizer page, on the Administration Page select Oracle Query Optimizer.

Surrounding text describes Oracle Query Optimizer screen.
Element Description
Hint Rules Configuration link Displays the Hint Rules Configuration Page.
Query Converter link Displays the Query Converter Page.
Hint Cache Updater link Displays the Hint Cache Updater Page.

A.1.3.6 Zone Fields Configuration Page

Access the Zone Fields Configuration page by selecting Zone Fields Configuration from the Administration tray in the portal navigation bar.

Surrounding text describes Zone Fields Configuration screen.
Element Description
Search Engine drop-down list Select the search engine to be used to search the zone text fields (either Database or DatabaseFullText).
Zone Text Fields list Lists the zone text fields for the selected search engine. You can use the [Ctrl] and [Shift] keys on your keyboard to select multiple fields.
Text Fields list Lists the available text fields for selected search engine.

By default, text fields with a field length of 20 or less characters are not included in the Text Fields list. You can change this setting by modifying the MinFullTextFieldLength configuration variable.

Right and left arrow buttons Move selected fields between the Zone Text Fields and Text Fields lists.
Update button Enables text fields in the Zone Text Fields list as zone text fields, and disables text fields in the Text Field list. Parses the text within all zone text fields and creates a full-text index that can be queried using the Contains search operator.

Changing a text field to a zone text field can be a very time-consuming operation. The amount of time it takes to parse the text and create the full-text index depends on the number of content items in the content server and the amount of text stored in the text field. However, when the text field has been indexed, you should not experience significant performance issues when updating and adding content items.

Reset button Reverts the Zone Text Fields and Text Fields lists to the last saved lists.


Note:

Custom text fields (the Comments text field and any customer-created text fields) are shared between the Database and DatabaseFullText search engines, and therefore changing the status of these text fields for one search engine also applies the changes to the other search engine. Standard text fields (Author, Content ID, Content Type, Title, and so no) can be enabled or disabled independently for each search engine.

A.1.3.7 Hint Rules Configuration Page

The hint rules table contains the rules that the query optimizer uses to select hints during the Query Optimization Process. The rules in this table are displayed on the Hint Rules Configuration page. To access this page, select the Administration tray in the portal navigation bar, then Oracle Query Optimizer, then Hint Rules Configuration.

Surrounding text describes Hint Rules Configuration screen.
Element Description
Show/Hide hint rule editor toggles By default, the Edit Query Hint Rules Table is displayed only after accessing the Hint Rules Configuration page. One toggle switch is located above the configuration table and the other is positioned below the table. When the Edit Query Hint Rules Table is displayed, both toggles convert to Hide hint rule editor.

Show hint rule editor: Displays the Hint Rule Editor.

Hide hint rule editor: Conceals the Hint Rule Editor.

Hint rules configuration table columns Key: The unique name to identify the rule.

Table: Identifies the specific database table.

Column: Identifies the specific column within the database table listed in the Table column.

Operator: A comma-delimited list of allowable operators.

Index: Identifies the specific index to use in the optimized queryif the condition meets the hint rule requirements.

Order: Contains the preferred order to use when the rule is included in the hint rules table.

Values: This column is Idoc scriptable. This column can only be defined when the Operators column has one of two specific values.

AllowMultiple: Indicates whether the defined index is used with other indexes.

Disabled: Indicates whether a hint rule has been disabled.


A.1.3.8 Edit Query Hint Rules Table

The Edit Query Hint Rules Table provides a way to add, remove, enable, or disable rules for the Hint Rule Editor. The Hint Rule Editor is accessed by clicking one of the Show hint rule editor toggles on the Hint Rules Configuration Page and is displayed below the hint rules configuration table.

Surrounding text describes Edit Query Hint Rules Table.
Element Description
Key field The unique name that identifies the hint rule.
Table field and menu Identifies the database table associated with the hint rule. The menu lists the current database tables. Selecting a table from the menu automatically populates the Column field, Column menu options, Index field and Index menu options.
Column field and menu Identifies the database table column associated with the hint rule. Selecting a column from the menu automatically populates the Index field and Index menu options.
Index field and menu Identifies the index associated with the hint rule.
Operators field and menu Identifies the specific operator(s) associated with the hint rule. Valid options include:

equal: Compares records to find equal values.

like: Compares records to find similar values.

in: Compares records to find values equal to any member of the specified item(s). Using this operator enables you to define the Values field.

greater: Compares records to find larger values on the left.

ge: (greater than or equal to) Compares records to find equal values or larger values on the left.

le: (less than or equal to) Compares records to find equal values or smaller values on the left.

less: Compares records to find larger values on the right.

notEqual: Compares records to find different values.

notIn: Compares records to find values that are not equal to any member of the specified item(s). Using this operator enables you to define the Values field.

notLike: Compares records to find dissimilar values.

generic: This operator is necessary if multiple operators are used in the conditions and are connected by an OR conjunction. For example: dIndexerState IS NULL OR dIndexerState IN ('N', 'Y').

range: This operator can be applied to an Integer field or a Date field. This operator is necessary when the Values field is defined with a valid range of values that would cause the hint to be applied. Using this operator enables you to define the Values field.

Order menu In descending order from 5 to 1, indicates the preference value of the hint rule. During the optimization process, the highest ranked hint rule that meets the condition's requirements is selected.
Values field Specifies applicable quantities when used with the operators in, notIn, and range; see the Operators field on the Edit Query Hint Rules Table.
AllowMultiple menu Available options include:

Yes: The defined index can be used with other indexes.

No: The defined index must be used alone.

Add/Enable button Used to add/edit a hint rule or activate a disabled hint rule.
Disable button Deactivates the selected rule.
Remove button Deletes the selected hint rule from the hint rules table. Only rules added using the Hint Rule Editor can be removed.

A.1.3.9 Query Converter Page

The Query Converter page displays the result of a converted query and enables you to modify a converted query by adding, editing, or deleting conditions from the WHERE clause. Modifying a converted query enables you to see exactly what will be executed when the query is submitted. Converted queries can optionally include data sources. The Query Converter page is accessed from the Hint Rules Configuration Page by selecting the Administration tray in the portal navigation bar, then Oracle Query Optimizer, then Query Converter.

The following figures show two types of query converter pages: a page that uses a data source, and a page that does not use a data source.

Query Converter screen with data source
Query Converter screen without data source
Element Description
Use Data Source check box This check box acts as a toggle switch to display or hide the fields related to converting a data source.

Selected: On the Query Converter page, displays all the fields.

Clear: On the Query Converter page, hides the DS Name menu and text area and the Additional Parameters field on the Hint Cache Updater Page.

DS Name menu and text area The menu lists the available data source names and, when you select one, the text area displays the current contents of the data source query.
Additional Parameters field One or more variables that are evaluated for the data source used to generate a query related to a specific environment.
Where Clause/Query field where Clause: This field is displayed when the Use Data Source check box is selected. Enables you to enter additional conditions that are appended to the existing WHERE clause in the data source. You can copy and paste an existing WHERE clause or enter it manually.

Query: This field displays when the Use Data Source check box is clear. Enables you to enter a full query to be evaluated. You can copy and paste an existing query or enter it manually.

Convert Query button Submits the information for the data source or query to be evaluated using the Query Optimization Process. The submitted data source or query is converted from a standard query to an optimized query that uses customized hints.

A.1.3.10 Hint Cache Updater Page

The Hint Cache Updater Page enables you to add a new entry, edit an existing entry, or remove an existing entry which enables you to fine tune query hints. Additionally, you can monitor and edit entries in the hint cache at run time to customize them for specific queries. The Hint Cache Updater page is accessed from the Hint Rules Configuration Page by selecting the Administration tray in the portal navigation bar, then Oracle Query Optimizer, then Hint Cache Updater.

The following figures show two types of query converter pages: a page that uses a data source, and a page that does not use a data source.

Hint Cache Updater screen with data source
Hint Cache Updater screen without data source
Element Description
Use Data Source check box This check box acts as a toggle switch to display or hide the fields related to managing the data source-based entries in the hint cache.

Selected: On the Hint Cache Updater page, displays all the fields.

Clear: On the Hint Cache Updater page, hides the DS Name menu and text area and the Additional Parameters field.

DS Name menu and text area The menu lists the available data source names and, when you select one, the text area displays the current contents of the data source query.
Additional Parameters field One or more variables that are evaluated for the data source used to generate a query related to a specific environment.
where Clause/Query field where Clause: This field is displayed when the Use Data Source check box is selected. Enables you to enter additional conditions that are appended to the existing WHERE clause in the data source. You can copy and paste an existing WHERE clause or enter it manually.

Query: This field displays when the Use Data Source check box is clear. Enables you to enter a full query to be evaluated. You can copy and paste an existing query or enter it manually.

Hints field Enter any additional hints for the data source or query. If you enter one or more Content Server Hints, the Oracle Query Optimizer component will consider them as default hints and they will not go through the Query Optimization Process. If you enter multiple hints, the feature will look for the best hint and, if possible, select multiple hints.
Check Cache button Evaluates the submitted query and checks the hint cache to determine if matching hints already exist. If so, they are returned. If not, the message, Hint does not exist in cache is displayed.

With data source: Combines the WHERE clause and hints and applies the additional parameters before submitting the query for evaluation.

Without data source: Combines the query and hints before submitting the query for evaluation.

Update Cache button Ensures that the data source or query will always use the specified hints because the hint cache is updated. Thus, clicking this button results in a manual overwrite of the previously defined hint cache. From now on, the new hints will be used with this particular query.
Remove button Removes the information entered into any of the fields for the specified query.

A.1.3.11 Admin Actions Page

You can use the Admin actions status page to remotely view the status and perform basic administration tasks for localization indexing, automatic update cycle, and collection rebuild cycle functions. To access this page, select the Administration tray in the portal navigation bar, then click Admin Actions.

Surrounding text describes Admin Actions screen.
Element Description
Weblayout Publishing area Displays status information and actions for weblayout publishing. You can click to publish dynamic layout files, to publish static layout files, and to view a progress trace.
Schema Publishing area Displays status information and actions for schema publishing. You can click links to publish schema configuration, publish schema configuration and data, and to view a progress trace.
Localization Indexing area Displays status information and actions for localization indexing. You can click links to build a string index.
Automatic Update Cycle area Displays status information and actions for the document index update cycle. You can click links to start, suspend, and cancel an update cycle.
Collection Rebuild Cycle area Displays status information and actions for the document index rebuild cycle. You can click links to start, suspend, and cancel a rebuild cycle.

A.1.4 File Store Administration Interface

The FileStore Provider component is installed and enabled by default. This component adds the following pages to Content Server:

A.1.4.1 Partition Listing Page

The Partition Listing page displays a list of all current partitions, indicating their root and status. To access the Partition Listing page, select the Administration tray in the portal navigation bar and click File Store Administration. Elements of each partition listed can be modified using the Add/Edit Partition Page, and their values are stored in the PartitionList resource table in the fsconfig.hda file, located in the IntradocDir/data/filestore/config directory.

Surrounding text describes Partition Listing screen.
Element Description
Partition Name Displays the name of the partition as defined when the partition was created using the Add/Edit Partition Page. The partition name is part of the path expression used by Content Server when storing content.
Partition Root Displays the root level to where content is being stored for this partition and is one of the arguments passed to the algorithm used by Content Server to choose a storage location for content. This value can be a static string, such as C:/vault, an expression, such as $#env.VauldDir$, or an Idoc Script variable, such as $HttpWebRoot$.
Is Active Displays whether a partition is active (TRUE) or not (FALSE). Active partitions are available to store content.
Action Displays the item action menu for each partition, from which you can choose to edit or delete the partition.
Add Partition Clicking Add Partition displays the Add/Edit Partition Page, which can be used to add and activate a new partition for use by Content Server.

A.1.4.2 Add/Edit Partition Page

The Add/Edit Partition Page is used to create and modify partitions used by Content Server to store content. To access the Add/Edit Partition page, click Add Partition on the Partition Listing Page. Values entered here are stored in the Partition List Table in the fsconfig.hda file, located in the IntradocDir/data/filestore/config/ directory.

Surrounding text describes Add/Edit Partition screen.
Element Description
Partition Name Defines the unique name of the partition. The partition name is displayed on the Partition Listing Page and is part of the path expression used by Content Server to store content. As such, it must be unique for each partition created, and has the same character limitations as Idoc Script and HTML path expressions.
Partition Root Defines the root level of the path to where content is stored for this partition and is one of the arguments passed to the algorithm used by Content Server to choose a storage location for content.
Capacity Check Interval Specifies the interval used in determining the disk space available for use by this partition. Expressed in seconds. This argument may not work on all platforms.
Slack Bytes Specifies the point at which a partition is full and can no longer accept content. If the available space on the partition is lower than the specified number of slack bytes, the partition no longer accepts new content.
Duplication Methods Specifies how native files are treated when not converted to a web-viewable rendition. For example, many image files do not require a rendition to be web-viewable. Linking to the native file instead of copying them to the web path helps manage storage space.

copy (default): copies the native file to the web path.

link: Resolves the web path to the native file in the vault

Is Active Specifies whether the partition is active and available for new content.
Update Submits the information specified creates or updates the partition.
Reset Resets the information to the previous state before updating the partition.

A.1.4.3 FileStore Provider Information Page

The FileStore Provider Information page for a FileStore provider displays information about the selected provider, including the connection state, last activity date, and the provider type, class, and connection.

To display the FileStore Provider Information page, click Info next to a FileStore provider on the Providers Page.

Click Edit on the FileStore Provider Information page to display the Edit File Store Provider Page, where details of the FileStore Provider can be modified.

File Store Provider Information screen

A.1.4.4 Edit File Store Provider Page

The Edit File Store Provider page is used to modify the existing file store. To access the Edit File Store page, click Edit on the FileStore Provider Information Page.

The information entered on this page is stored in the provider.hda file located in the IntradocDir/data/providers/defaultfilestore directory. The default values will handle most storage scenarios.

Edit File Store Provider screen
Element Description
Provider Name Defines the name of the provider.
Provider Description A descriptive phrase displayed on the Providers Page identifying the provider.
Provider Class The path to the Java class file governing provider functionality. The default class file is BaseFileStore.
Connection Class This is a path to a Java class file that is not applicable to Content Server. Do not enter a value.
Configuration Class The path to the Java class file used to configure file store provider functionality.
Access Implementor The path to the Java class file called to access content.
Descriptor Implementor The path to the Java class file called when describing content.
Event Implementor The path to the Java class file called when implementing an event, such as indexing or searching.
Metadata Implementor The path to the Java class file called when needing information about content.
Storage Rules Lists the storage rules used for the provider. Select the rule to edit, or select Add rule to create additional rules.
Edit Rule Accesses the Add/Edit Storage Rule Page for adding or modifying storage rules.

A.1.4.5 Add/Edit Storage Rule Page

The Add/Edit Storage Rule page is used to confide how and where each provider stores content checked into Content Server. This page defines if content is stored on a file system or within a database, if a Web rendition is created, and how the paths to the content are constructed. To access the Add/Edit Storage Rule page, click Edit Rule next to the Storage Rules menu on the Edit File Store Provider Page.

Add/Edit Storage Rule screen
Element Description
File system only Specifies that content checked into Content Server be stored only on a specified file system, and not in a database. This includes both the native and web-viewable files unless the Is Webless File Store option is enabled.
Is Webless File Store Specifies that a web-viewable rendition content not be created.
JDBC Storage Specifies that content checked into Content Server be stored only in a database, and not on a file system. This includes both the native and web-viewable files unless an option is selected from the Renditions choice list.
Renditions Specifies a rendition to store on a file system when JDBC Storage is enabled.

No selection (default): Both the native and web-viewable renditions are stored in the database.

Web Files: Stores web-viewable renditions on a file system and native files in the database.

Vault Files: Stores native files on a file system and web-viewable files in the database.

Show Path Metadata Expands the screen to display detailed information about the metadata used for constructing paths used by the provider.
Vault Path The expression defining the path to the vault location where native content checked into Content Server server is stored for the provider using this rule.
Web-viewable Path The expression defining the path on the file system to the web-viewable rendition.
Web URL File Path The URL used to access the web-viewable rendition in a browser.


Important:

If the web root used in the web URL file path defined in the storage rule is something other than the default weblayout directory defined for Content Server, you must add an alias or virtual directory in your web server for the web root used in the storage rule. Otherwise, Content Server does not know where to access the file. For information on adding virtual directories to your web server, see the documentation that came with your web server.

A.1.4.6 Path Information Screen

The Path Information screen displays details about metadata used for constructing paths used by the provider. To view the Path Information screen, click Show Path Metadata on the Add/Edit Storage Rule Page.

Surrounding text describes Path Information screen.

A.1.5 Web Server Interface Screens

This section covers these topics:

A.1.5.1 Configure Web Server Filter Page

The Configure Web Server Filter page is used to configure and troubleshoot Web server filter communication with Content Server. Because Oracle WebLogic Server handles Web server communication, most of the options on this page are not relevant except for the GZIP encoding option. The settings can still be modified and can be relevant if a separate Web server is used as an access point for this Content Server instance.

To access this page, click the Filter Administration link in the Administration tray in the portal navigation menu.

Configure Web Server Filter screen
General Options Description
Cache Timeout field Sets the amount of time in minutes that the web server holds user credentials. To maintain the content server user credentials, you should select a finite time for the web server to cache user data.
Default Authentication field The first time a user logs into the content server, a cookie is sent to the filter. If you change the default authentication from the default Basic to NTLM, the first time a user logs into the content server the user will not be prompted to log in again because their credentials will automatically be authenticated.
Disable GZIP Compression For optimal performance, the content server compresses the HTML response pages. This option is useful for debugging purposes.

TRUE = Prevents the content server from compressing HTML response pages.

FALSE = Configures the content server to compress HTML response pages. This is the default setting.


When you select any of the logging options, a Web server filter log file is created as follows:

  • Apache: IntradocDir/data/users/authfilt.log

    Logging Options Description
    CGI_DEBUG check box Enables logging of high-level information that is passed through the web server filter. This is helpful in determining password and user authentication problems.
    CGI_SEND_DUMP check box Enables logging of all incoming data that is passed through the web server filter.
    CGI_RECEIVE_DUMP check box Enables logging of all outgoing data that is passed through the web server filter.
    FILTER_DEBUG check box Enables logging of events that occur inside the web server filter.
    PLUGIN_DEBUG check box Enables logging of events that occur inside any web server plug-in filters that understand this flag.

The following buttons and other options are also available.

Other Options Description
Update button Saves any changes to the web filter configuration settings.
Reset button Returns the web filter configuration settings to their last saved values.

A.1.5.2 WebUrlMaps Screen

Use the WebUrlMaps screen to add or edit URL mapping entries. It does the mapping inside Oracle WebLogic Server. To access this screen, select Administration, then click WebUrlMaps. This option is installed and enabled by default with Content Server deployment.

Surrounding text describes WebUrlMaps screen.
Element Description
Text pane Provides an overview and general information about the WebUrlMaps feature. Use the side scroll bar to view all the text.
Prefix field The abbreviation that is used as a filter to evaluate whether a URL should be processed using a defined mapping script.
Map field The script used to process applicable URLs and map them to the resulting URL.
Update button Saves the changes made in the Prefix and Map fields.
Reset button Reverts the values of the Prefix and Map fields to their previously saved settings. Any values entered but not saved are removed from the fields.

A.1.6 Provider Interface

The following screens are used when managing Content Server providers:

A.1.6.1 Providers Page

The Providers page is used to find provider information, test providers, or add providers. To access this page, do one of the following:

  • Click the Providers link from the Administration tray in the portal navigation bar.

  • Click the View Providers link in the side navigation bar on the Admin Server Page.

Surrounding text describes Providers screen.
Providers Table Description
Provider column Name of the provider that establishes connection to outside entities.
Description column Description of the provider that establishes connection to outside entities.
Type column The type of provider. This can include incoming, outgoing, database, preview, ldapuser, keepaliveincoming, keepaliveoutgoing, sslincoming, ssloutgoing, jpsuser, httpoutgoing, FileStore.
Connection State column Possible states are:
  • misconfigured

  • good

  • down

  • requires restart

Last Activity Date column The last date and time that the provider was active.
Action column The Info link displays the Provider Information Page for the provider.

The Test link refreshes the Connection State and Last Activity Date columns for the provider.


New Provider Table Description
Provider Type column The type of provider.This can include:
Description column Description of the provider type.
Action column Click the Add button to display the Add/Edit Provider Page for the provider type listed in the row.

A.1.6.2 Provider Information Page

The Provider Information page is used to review, edit, disable, or delete existing providers information. To access this page, click the Info link in the Action column for the row that corresponds to a provider on the Providers Page.


Note:

You can only edit, disable, or delete providers that you have created. You cannot edit, disable, or delete providers installed with the Content Server system.

Surrounding text describes Provider Information screen.
Element Description
Information fields Displays information about the provider. The information shown depends on the type of provider and the content server configuration. See "Add/Edit Provider Page" for a description of each field.
Edit button Displays the Add/Edit Provider Page for the provider. This button is not displayed for the default system providers.
Disable/Enable button Disables or enables the provider. The content server must be restarted after a provider is disabled or enabled.

This button is not displayed for the default system providers.

Delete button Deletes the provider. This button is not displayed for the default system providers.

A.1.6.3 Add/Edit Provider Page

The Add/Edit Provider page is used to create or edit a provider.

  • To access the Add Provider page, click the Add link in the row for the type of provider you want to create on the Providers Page.

  • To access the Edit Provider page, click Edit in the row for the provider type on the Provider Information Page.

The fields on the Add/Edit Provider page depend on the type of provider being created or edited:

Other providers may be listed depending on your content server configuration.

A.1.6.4 Outgoing Provider Page

The Add/Edit Outgoing Provider page is used to create or edit an outgoing socket provider. To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.

Edit Outgoing Socket Provider screen
Element Description
Provider Name field The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.
Provider Description field User-friendly description of the provider.
Provider Class field The name of the Java class for the provider. For example, intradoc.provider.SocketOutgoingProvider.
Connection Class field The name of the Java class that implements the provider connection. For example, intradoc.provider.SocketOutgoingConnection.
Configuration Class field The name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers.
Server Host Name field The server host name (IDC_Name) of the other content server instance.
HTTP Server Address field The HTTP address of the other content server instance. For example, intradoc:90.
Server Port field The port on which the provider communicates with the other content server.
Instance Name field The instance name of the other content server instance.
Relative Web Root field The relative Web root of the other content server instance. For example, /_install_dir__instance_dir__2/.
Use Connection Password check box If selected, Named Connections is used, and a connection name and password is required to access the target server.
Connection Password Name field The name of the connection password.
Connection Password field The connection password.
Client IP Filter field The client IP addresses that are allowed to use the connection to the target server.
Handles Inbound Refinery Conversion Jobs check box If selected, Inbound Refinery is used by this provider.
Inbound Refinery Read Only Mode check box If selected, prevents Content Server from sending new conversion jobs to Inbound Refinery with this provider.
Add/Update button Saves the provider information.
Reset button Resets the provider information to the last saved values.

A.1.6.5 Database Provider Page

The Add/Edit Database Provider page is used to create or edit a database provider.


Note:

The SystemDatabase Provider uses the Oracle WebLogic Server data source, which in turn handles the actual database authentication and communication.

To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.

Surrounding text describes Add Database Provider screen.
Element Description
Provider Name field The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.
Provider Description field User-friendly description of the provider.
Provider Class field The name of the Java class for the provider. For example, intradoc.jdbc.JdbcWorkspace.
Connection Class field The name of the Java class that implements the provider connection. For example, intradoc.jdbc.JdbcConnection.
Configuration Class field The name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers.
Database Type menu The database type. Types include ORACLE, MSSQLSERVER, DB2, SYBASE.
JDBC Driver field The JDBC driver name for the database type. When the database type is selected, an appropriate driver is automatically filled.
JDBC Connection String field The JDBC connection string for the database type. When the database type is selected, an appropriate string is automatically filled.
Use Data Source check box When selected, this specifies that the provider use a data source.
Data Source field Specify the data source.
Test Query field The test query will be used to test the provider when the Test link on the Providers page is clicked. When the database type is selected, a test query is automatically filled. You can choose to enter a different test query.
Database Directory field The directory that contains the content server database information. For example, IntradocDir/database. Used only by DAO databases.
Database Name field Used only by DAO databases.
JDBC User field Your JdbcUser.
JDBC Password field Your JdbcPassword.
Number of Connections field The number of database connections the provider maintains. This is used only by JDBC databases.
Extra Storage Keys field The extra storage keys required for the connection. A system storage key is automatically filled.
Additional Settings field Any additional configuration settings for the database provider.
Add/Update button Saves the provider information.
Reset button Resets the provider information to the last saved values.

A.1.6.6 Incoming Provider Page

The Add/Edit Incoming Provider page is used to create or edit an incoming provider. To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.

Surrounding text describes Add Incoming Provider screen.
Element Description
Provider Name field The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.
Provider Description field User-friendly description of the provider.
Provider Class field The name of the Java class for the provider. For example, intradoc.provider.SocketIncomingProvider.
Connection Class field The name of the Java class that implements the provider connection. For example, intradoc.provider.SocketIncomingConnection.
Configuration Class field The name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers.
Server Port field The port the provider listens on for incoming connections. For example, the incoming system provider listens on port 4444 by default.
Add/Update button Saves the provider information.
Reset button Resets the provider information to the last saved values.

A.1.6.7 Preview Provider Page

The Add/Edit Preview Provider page is used to create or edit a preview provider. To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.

Surrounding text describes Add Preview Provider screen.
Element Description
Provider Name field The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.
Provider Description field User-friendly description of the provider.
Provider Class field The name of the Java class for the provider. For example, intradoc.provider.SocketOutgoingProvider.
Connection Class field The name of the Java class that implements the provider connection. For example, intradoc.provider.SocketOutgoingConnection.
Configuration Class field The name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers.
Server Host Name field The server host name of the other content server instance. For example, localhost.
HTTP Server Address field The HTTP address of the other content server instance. Use the value listed for HTTP Server on the Configuration Information page. For example, intradoc:90.
Server Port field The port on which the provider communicates with Oracle Content Publisher. Typically, this is 4441.
Add/Update button Saves the provider information.
Reset button Resets the provider information to the last saved values.

A.1.6.8 LDAP Provider Page

The Add/Edit LDAP Provider page is used to create or edit an LDAP provider and configure Content Server integration with LDAP security. To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.


Note:

It is recommended that the JPS user provider be used with Oracle WebLogic Server. See JPS User Provider Page.

In the following tables, the term in parentheses in the first column is the corresponding configuration setting in the IntradocDir/data/providers/provider_name/provider.hda file.

Surrrounding text describes Add LDAP Provider screen.
Element Description
Provider Name field The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.
Provider Description field* A user-friendly description of the provider.
Provider Class field*

(ProviderClass)

The name of the Java class that implements the provider.
  • Default is intradoc.provider.LdapUserProvider.

Connection Class field

(ProviderConnection)

The name of the Java class that implements the connection to the LDAP server. Default is intradoc.provider.LdapConnection.
Configuration Class field

(ProviderConfig)

The name of a Java class that performs some extra configuration. This class is useful for database providers, where the connection classes are already providers.
Source Path field*

(SourcePath)

A unique string that identifies the 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 provider as the Source Path.
LDAP Server field*

(LdapServer)

Host name of the LDAP server.
LDAP Suffix field*

(LdapSuffix)

The root suffix (naming context) to use for all LDAP operations (such as o=company.com or dc=company,dc=com). All mapping of LDAP groups to Content Server roles and accounts will begin at this root.

Do not include spaces before or after commas.

LDAP Port field*

(LdapPort)

The port the LDAP server listens on. The default is 389. If you are using SSL, you should set this to 636.
Number of connections field

(NumConnections)

The number of LDAP server connections the provider maintains.
Connection timeout field The amount of time (in minutes) that a provider connection to the LDAP server is held open before the provider connection is closed and reopened.

For best results, set the amount of time to less than 15 minutes. If the amount of time is 15 minutes or greater, there could be a problem with the JNDI layer not holding the connection open.

Priority field

(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 Content Server. If the user has previously requested credentials, the Source Path will be stored for that user, so the LDAP provider specified by the Source Path will be used.

  • Each LDAP provider in a Content Server instance must have a unique Priority number.

Credential Map field Specifies a credential map.
Using Netscape SDK check box

(UseNetscape)

There are two ways to connect to the LDAP server: using the Netscape SDK or using JNDI. This check box acts as a toggle between the two options.

Selected = Use Netscape SDK

Clear = Use JNDI

Use SSL check box

(UseSecureLdap)

If you select this check box, you must have the appropriate certificates installed on the LDAP server. When SSL is initiated, the certificates will secure communication between the LDAP server and the content server.

If you use a self-signed certificate for your LDAP server and select to use SSL, you may need to add the LDAP server's certificate to the JVM trusted certificate keystore to avoid a connection error with LDAP Port 636. The basic command for importing a certificate into the JVM keystore is the following:

%JAVA_HOME%\bin\keytool -import -file 
server certificate file -alias server alias -keypass changeit -keystore
%JAVA_HOME%/jre/lib/security/cacerts
Use Group Filtering check box

(UseGroupFilter)

Selected: The Role Prefix and Account Prefix definitions will be used to select the LDAP groups that will be mapped to Content Server roles and accounts.

Clear: All LDAP groups will be mapped to Content Server roles and accounts. This is the default.

Use Full Group Names check box

(UseFullGroupName)

Selected: The entire hierarchy (up to the specified prefix or naming context) for an LDAP group will be included in the mapping to a Content Server role or account.

Clear: Only the lowest level unit of an LDAP group will be mapped to a Content Server role or account. This is the default.

Account Permissions Delimiter field

(AcctPermDelim)

The string that separates the account names from the account permissions in an LDAP group name.
  • If an LDAP group name is mapped to an account and contains this substring, the string to the left of this substring will be the account name, and the string to the right of this substring will be the account permissions.

  • For example, if the delimiter is defined as a + (plus sign), the group name Acct1+rw would map to an account named Acct1 with Read and Write permission. If the delimiter is defined as an _ (underscore), the Acct1+rw group name would map to an account named Acct1+rw, with RWDA permission by default.

  • The default is _ (underscore).

  • This field appears only if accounts are enabled in Content Server.

Default Network Roles field The default role or roles assigned to a user who enters through this provider; for example, contributor.
Default Network Accounts field

(DefaultNetworkAccounts)

Defines the default account permissions for users who log in to Content Server with LDAP credentials.
  • This must be a comma-delimited list of accounts. Do not include spaces before or after the commas that separate accounts.

  • Permissions for each account can be specified in parentheses after the account name, such as account(RWDA). If no permissions are specified, RWDA permission is granted by default.

  • The #none entry grants permission to documents that have no account assigned.

  • The #all entry grants permissions to all accounts.

  • The default is #none(RWDA).

  • This setting does not apply to anonymous users.

  • This setting defines the minimum account permissions. Account permissions defined by the external user base are added to these permissions. For example, if the default is #none(RW),Project(R), and a user's group maps to Project(RWD) permission, the user's permissions are #none(RW),Project(RWD).

  • This field appears only if accounts are enabled in the Content Server.

Role Prefix field The string that specifies where in the LDAP group name to start matching a Content Server role name.
Role Prefix Depth field A number that specifies how many levels the LDAP group name can contain after the Role Prefix for the group name to be considered a valid role. Placing an asterisk (*) in the depth parameter for a specific prefix ensures that the short name for any group mapped through the prefix is used.
Role Prefix Add button Adds the Role Prefix string and Depth as a clause in the Role Prefix box.
Role Prefix box

(RolePrefix)

Lists the Role Prefix clauses that will be used to select LDAP groups when the Group Filtering check box is selected. This box can be edited directly.

Do not include spaces before or after the commas that separate units in a prefix.

Account Prefix field The string that specifies where in the LDAP group name to start matching a Content Server account name.

This field appears only if accounts are enabled in Content Server.

Account Prefix Depth field A number that specifies how many levels the LDAP group name can contain after the Account Prefix for the group name to be considered a valid account.

This field appears only if accounts are enabled in the Content Server.

Placing an asterisk (*) in the depth parameter for a specific prefix ensures that the short name for any group mapped through the prefix is used.

Account Prefix Add button Adds the Account Prefix string and Depth as a clause in the Account Prefix box.

This button appears only if accounts are enabled in Content Server.

Account Prefix box

(AcctPrefix)

Lists the Account Prefix clauses that will be used to select LDAP groups when the Group Filtering check box is selected. This box can be edited directly.

Do not include spaces before or after the commas that separate units in a prefix.

This box appears only if accounts are enabled in Content Server.

LDAP Attribute field Enter an LDAP user attribute to be mapped to a Content Server user information field.
User Attribute field Select a Content Server user information field to be mapped from the LDAP Attribute field.
  • All Content Server user information fields for which you can change the value are listed.

  • Standard user information fields begin with a "d".

  • Custom user information fields begin with a "u".

User Attribute Add button Adds the LDAP Attribute and User Attribute as a colon-separated clause in the Attribute Map box.
Attribute Map box

(AttributeMap)

Lists the Attribute Map clauses that will be used to map LDAP user attributes to Content Server information fields.
  • This box can be edited directly.

  • If this field is left blank, the default is:

mail:dEmail
cn:dFullName
title:dUserType
LDAP Admin DN field

(LdapAdminDN)

The user name that will be making calls to the LDAP server.
  • This user must have Read rights to the LDAP server.

  • If the user name is left blank, the provider will connect to the LDAP server anonymously.

Ldap Admin Password field

(LdapAdminPassword)

The password for the user that will be making calls to the LDAP server.
Add/Update button Saves the provider information.
Reset button Resets the provider information to the last saved values.

A.1.6.9 keepaliveincoming Provider Page

The Add Incoming Provider page for the keepalive function is used to create or modify a keepalive socket incoming provider. To access this page, select the Administration tray in the portal navigation bar, then select the Providers link to display the Providers Page. Click Add in the Action column for the keepaliveincoming provider type.

Add Incoming Provider screen for keepalivesocket
Element Description
Provider Name field (Required) Name of the provider.
Provider Description field (Required) Description of the provider.
Provider Class field (Required) Name of the Java class for the provider. For example: idc.provider.ExtendedSocketIncomingProvider
Connection Class field Name of the Java class that implements the provider connection. For example: idc.provider.KeepaliveSocketIncomingConnection
Configuration Class field Name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers.
Server Thread field Name of the server thread for incoming connections. For example: idc.provider.KeepaliveIdcServerThread
Server Port field (Required) Port the provider listens on for incoming connections. For example, the incoming system provider for Universal Content Management listens on port 4444 by default.
Add/Update button Saves the provider information.
Reset button Resets the provider information to the last saved valued.

A.1.6.10 keepaliveoutgoing Provider Page

The Add Outgoing Provider page for the keepalive function is used to create or modify a keepalive socket outgoing provider. To access this page, select the Administration tray in the portal navigation bar, then select the Providers link to display the Providers Page. Click Add in the Action column for the keepaliveoutgoing provider type.

These two images show the keepaliveoutgoing provider page.

Add Outgoing Provider screen for keepalivesocket
Add Outgoing Provider screen for keepalivesocket
Element Description
Provider Name field (Required) Name of the provider.
Provider Description field (Required) Description of the provider.
Provider Class field (Required) Name of the Java class for the provider. For example: idc.provider.KeepaliveSocketOutgoingProvider
Connection Class field Name of the Java class that implements the provider connection. For example: idc.provider.KeepaliveSocketOutgoingConnection
Configuration Class field Name of a Java class that performs some extra configuration.
Request Class field Name of the Java class that implements the server request. For example: idc.provider.KeepaliveServerRequest
Number of Connections field Maximum number of connections. For example, 3.
Server Host Name field (Required) Server host name of the other content server instance. For example, localhost.
HTTP Server Address field HTTP address of the other content server instance.
Server Port field (Required) Port on which the provider communicates with the other content server.
Instance Name field (Required) Name of the other content server instance.
Relative Web Root field (Required) Relative web root of the other content server instance.
Proxied check box Enable this option if the provider is connecting to a content server that will be controlled by the current instance.
Notify Target check box Enable this option if the provider is connecting to a content server that is acting as a controlling instance, and you want this content server to notify the controlling instance when user information and/or content item information changes.
Users check box Enable this option if you want this content server to notify the controlling instance when user information changes.
Released Documents check box Enable this option if you want this content server to notify the controlling instance when content item information changes.
Enterprise Searchable check box Enable this option if you have enabled Enterprise Search and you want this content server instance to be searchable.
Required Roles field Enter roles that have permission to search this content server instance using Enterprise Search. If no roles are entered, all users will have permission.
Account Filter field Enter accounts that have permission to search this content server instance using Enterprise Search. If no accounts are entered, all users will have permission.
Conversion options Select the appropriate options if the provider uses Inbound Refinery.
Add button Saves the provider information.
Reset button Resets the provider information to the last saved values.

A.1.6.11 sslincoming Provider Page

The Add Incoming Provider page for the sslincoming function enables administrators to create an SSL socket incoming provider. To access the page, select the Administration tray in the portal navigation bar, then select the Providers link to display the Providers Page. Click Add in the Action column for the sslincoming provider type.

Add Incoming Provider screen for keepalivesocket
Element Description
Provider Name field (Required) Name of the provider.
Provider Description field (Required) Description of the provider.
Provider Class field (Required) Name of the Java class for the provider. For example: idc.provider.ssl.SSLSocketIncomingProvider
Connection Class field Name of the Java class that implements the provider connection. For example: idc.provider.KeepaliveSocketIncomingConnection
Configuration Class field Name of a Java class that performs some extra configuration. This class is very useful for database providers, where the connection classes are already providers
Server Thread field Name of the server thread for incoming connections. For example: idc.provider.KeepaliveIdcServerThread
Server Port field (Required) Port the provider listens on for incoming connections. For example, the incoming system provider listens on port 4444 by default.
Request Client Authentication check box Enable this option if you want the provider to request client authentication from the incoming connection.
Require Client Authentication check box Enable this option if you want the provider to require client authentication from the incoming connection.
Keystore/Alias/Truststore information If necessary, enter the keystore password name, the alias, the alias password, and the truststore password.
Add button Saves the provider information.
Reset button Resets the provider information to the last saved values.

A.1.6.12 ssloutgoing Provider Page

The Add Outgoing Provider page for the ssloutgoing function enables administrators to create an SSL socket outgoing provider. To access the page, select the Administration tray in the portal navigation bar, then select the Providers link to display the Providers Page. Click Add in the Action column for the ssloutgoing provider type.

These two images show the ssloutgoing provider page.

Add Outgoing Provider screen for keepalivesocket
Add Outgoing Provider screen for keepalivesocket
Element Description
Provider Name field (Required) Name of the provider.
Provider Description field (Required) Description of the provider
Provider Class field (Required) Name of the Java class for the provider. For example: idc.provider.KeepaliveSocketOutgoingProvider
Connection Class field Name of the Java class that implements the provider connection. For example: idc.provider.KeepaliveSocketOutgoingConnection
Configuration Class field Name of a Java class that performs some extra configuration.
Request Class field Name of the Java class that implements the server request. For example: idc.provider.KeepaliveServerRequest
Number of Connections field Maximum number of connections. For example, 3.
Server Host Name field (Required) Server host name of the other content server instance. For example, localhost.
HTTP Server Address field HTTP address of the other content server instance.
Server Port field (Required) Port on which the provider communicates with the other content server.
Instance Name field (Required) Name of the other content server instance.
Relative Web Root field (Required) Relative web root of the other content server instance.
Keystore/Alias/Truststore information If necessary, enter the keystore password name, the alias, the alias password, and the truststore password.
Proxied check box Enable this option if the provider is connecting to a content server that will be controlled by the current instance.
Notify Target check box Enable this option if the provider is connecting to a content server that is acting as a controlling instance, and you want this content server to notify the controlling instance when user information and/or content item information changes.
Users check box Enable this option if you want this content server to notify the controlling instance when user information changes.
Released Documents check box Enable this option if you want this content server to notify the controlling instance when content item information changes.
Enterprise Searchable check box Enable this option if you have enabled Enterprise Search and you want this content server instance to be searchable.
Required Roles field Enter roles that have permission to search this content server instance using Enterprise Search. If no roles are entered, all users will have permission.
Account Filter field Enter accounts that have permission to search this content server instance using Enterprise Search. If no accounts are entered, all users will have permission.
Conversion options Select the appropriate options to have the provider use Inbound Refinery.
Add button Saves the provider information.
Reset button Resets the provider information to the last saved values.

A.1.6.13 JPS User Provider Page

The Add/Edit JPS User Provider page is used to create or edit a user provider which integrates with Oracle JPS. To access this page, click the Add link in the row for the provider type on the Providers Page, or click the Edit link in the row for the provider on the Provider Information Page.

Surrounding text describes JpsUserProvider screen.
Element Description
Provider Name field The name of the provider, which will become a subdirectory in the IntradocDir/data/providers/ directory.
Provider Description field A user-friendly description of the provider.
Provider Class field The name of the Java class that implements the provider.
Connection Class field The name of the Java class that implements the connection to the LDAP server.
Configuration Class field The name of a Java class that performs some extra configuration. This class is useful for database providers, where the connection classes are already providers.
Source Path field A unique string that identifies the 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 the next time the user asks for credentials. We suggest using the name of the provider as the Source Path.
JPS Context field Host name of the Oracle JPS server.
JPS Attributes list Select a JPS attribute to be mapped to a Content Server user information field.
User Attribute list Select a Content Server user information field to be mapped from the JPS attributes field.
  • All Content Server user information fields for which you can change the value are listed.

  • Standard user information fields begin with a "d".

  • Custom user information fields begin with a "u".

User Attribute Add button Adds the JPS Attribute and User Attribute as a colon-separated clause in the Attribute Map box.
Attribute Map box Lists the Attribute Map clauses that will be used to map user attributes to Content Server information fields.
  • This box can be edited directly.

  • If this field is left blank, the default is:

    mail:dEmail
    cn:dFullName
    title:dUserType
    
Default Network Roles field The default role or roles assigned to a user who enters through this provider. For example, contributor.
Add/Update button Saves the provider information.
Reset button Resets the provider information to the last saved values.

A.1.6.14 Outgoing Http Provider Page

The Add/Edit Outgoing Http Provider screen enables an administrator to add an httpoutgoing provider on the master content server. To access this page, select the Administration tray in the portal navigation bar, then click Providers. In the Create a New Provider pane, click Add in the Action column for the httpoutgoing provider.

Surrounding text describes Edit Outgoing Provider screen.
Element Description
Provider Name field* The name of the provider.
Provider Description field* A user-friendly description of the provider.
Provider Class field* The name of the Java class for the provider. For example: proxyconnections.HttpOutgoingProvider
Connection Class field The name of the Java class that implements the provider connection. For example: proxyconnections.HttpOutgoingConnection
Configuration Class field The name of a Java class that performs some extra configuration. Leave this blank.
CGI URL field* The URL for the proxy server.
Instance Name field* The instance name of the proxy content server.
Relative Web Root field* The relative web root of the content server instance.
Connection Password Name field The name of a password connection (this can be an existing name or a name for a password connection that you will create on the proxy server). The name must specify one of the target master server's proxied connections. The target server requires a named password.
Connection Password field The password for the named password connection.
Client IP Filter field The client IP address or addresses that can use this connection to the target server.
Proxied check box Enable this option if the provider is connecting to a remote server that will be controlled by this server.
Notify Target check box Enable this option if the provider is connecting to a server that is acting as a controlling (master) server, and you want this server to notify the controlling server when user information or content item information changes.
Users check box Enable this option to have this server to notify the controlling server when user information changes.
Released Documents check box Enable this option to have the controlling server perform an enterprise search that includes this server.
Enterprise Searchable check box Enable this option if you have enabled Enterprise Search and you want this content server instance to be searchable.
Required Roles field Enter roles that have permission to search this content server instance using Enterprise Search. If no roles are entered, all users will have permission.
Account Filter field Enter accounts that have permission to search this content server instance using Enterprise Search. If no accounts are entered, all users will have permission.
Handles Inbound Refinery Conversion Jobs check box (Inbound Refinery only) Use this option only if the provider is an Inbound Refinery.
Inbound Refinery Read Only Mode check box (Inbound Refinery only) Use this option to prevent the content server from sending new conversion jobs to this Inbound Refinery. This Inbound Refinery returns conversion jobs as the jobs are finished.
Conversion Options field (Inbound Refinery only) Enter the number of jobs allowed in the pre-converted queue. The default is 100.
Add button Saves the provider information.
Reset button Resets the provider information to the last saved values.

A.1.7 Scheduled Jobs Administration Interface

The following screens are used in monitoring and managing scheduled jobs in Content Server.

A.1.7.1 Active Scheduled Jobs Screen

This screen enables administrators to view active jobs in Content Server and to modify their actions. To access this screen, select Administration from the portal navigation bar, then expand Scheduled Jobs Administration, then click Active Scheduled Jobs.

Surrounding text describes Active Scheduled Jobs screen.
Element Description
Job Name column Name of the active job.
Job Description column Describes the purprose of the active job.
Processed column Date and time the job was processed or started processing.
Status column Current status of a job. You can move your cursor over each icon to display a brief description of the status represented by the icon.
  • High priority

  • Inactive

  • Repeat

  • Short

Actions column Use the Actions menu to implement the following actions on a job:
  • Info

  • Edit

  • Cancel

  • Delete

Use the Info icon to display the Job Information page.


A.1.7.2 Scheduled Jobs History

This screen enables administrators to view scheduled jobs history in Content Server. To access this screen, select Administration from the portal navigation bar, then expand Scheduled Jobs Administration, then click Scheduled Jobs History.

Surrounding text describes Scheduled Jobs History screen.
Element Description
Job Name column Name of the scheduled job.
Job Description column Describes the purpose of a job.
Last Processed column Date and time the job was last processed.
Last Status column Last status of a job: Succeeded, Failed.
Actions column Use the Info icon to display the Scheduled Jobs Information page.

A.1.7.3 Scheduled Jobs Information Screen

This screen enables administrators to view or edit information about a scheduled jobs in Content Server. To access this screen, select Administration from the portal navigation bar, then expand Scheduled Jobs Administration. Click either the Active Scheduled Jobs Screen or the Scheduled Jobs History and select the Info Icon to view jobs information. You can select Edit from the Actions menu on the Active Scheduled Jobs Screen to display a Scheduled Jobs Information screen that can be edited.

Surrounding text describes Job Information Page.
Element Description
Name field Name of the scheduled job. This can not be edited.
Description field Description of the scheduled job.
Category field Category of the scheduled job.
Exception Parent Job field This field can not be edited. If there is no exception parent job, nothing is displayed.
Initial User field Type of user that owns the scheduled job.
Queue Type field Type of queue: short, or long.
Type field Type of schedule: Immediate, Once, Repeat.
State field Current state of the scheduled job.
Priority field Priority number for the scheduled job.
Interval field Interval specified for the scheduled job to be processed: one hour, two hours, one day, one week.
Start Token field Token, if any, that triggers the schedule job to start processing.
Progress field The progress of the scheduled job.
Create Date field Date and time the scheduled job was created. This field can not be edited.
Update Date field Date and time the scheduled job was updated. This field can not be edited.
Process Date field Date and time the scheduled job was processed. This field can not be edited.
Last Processed Date field Date and time the scheduled job was last processed. This field can not be edited.
Last Processed Status field Status when the scheduled job was last processed. This field can not be edited.
Update button Updates the screen settings with edited changes.
Reset button Resets the screen settings to the original display.

A.1.8 Batch Interface Screens

The following screens are used in batch loading operations:

A.1.8.1 Batch Loader Application

The Batch Loader application is an administration application that is used to batch load files in the content server. To access this screen, follow the instructions for running administration applications in standalone mode.

Surrounding text describes Batch Loader screen.
Element Description
Options menu Save Configuration: Saves the current Batch Loader settings in the DomainHome/ucm/cs/bin/intradoc.cfg file.

Build Batch File: Displays the BatchBuilder Screen.

Exit: Closes the Batch Loader screen.

Help menu Contents: Displays the content server online help.

About Content Server: Displays version, build, and copyright information for the content server.

Batch Load File field The path and file name of the batch load file. If settings have not been saved to the intradoc.cfg file, the default is IntradocDir/samples/Batchloader/batchinsert.txt.
Browse button Enables you to navigate to and select the batch load file.
Maximum errors allowed field The number of errors after which the Batch Loader stops processing records from the batch load file. The default is 50.

If you plan to run the Batch Loader with a large number of files overnight, consider increasing this number so that the process does not stop prematurely.

If you are monitoring the Batch Loader closely, consider decreasing this number so you are notified of errors as they occur.

Clean up files after successful check in check box Deletes each file from the hard drive after it is successfully checked in or updated.
Enable error file for failed revision classes check box Creates a text file containing the file records that failed during batch loading. You can fix the errors in this content and rerun it as the batch load file.
Progress bar Displays the progress of the batch loading process.
Load Batch File button Starts the batch loading process.

A.1.8.2 BatchBuilder Screen

The BatchBuilder screen is used to create a batch load file. To access this screen, on the Batch Loader Application select the Options menu, then Build Batch File.

Surrounding text describes Batch Builder screen.
Element Required? Description
Options: Save Configuration N/A Saves the current BatchBuilder settings in the DomainHome/ucm/cs/bin/intradoc.cfg file.
Options: Load Batch Loader N/A Displays the Batch Loader Application.
Directory field Yes Enter the directory that contains the content to be included in the batch load file. All files in sub-directories of this directory will also be included in the batch load file.
Batch Load File field Yes Enter the path and file name of the batch load file to be created. If you enter the name of an existing file, the file will be replaced by the new batch load file.
Browse button N/A Enables you to navigate to and select the folder and enter a file name for the batch load file.
Mapping list Yes Select the mapping file to be used to specify metadata values.
Edit button N/A Displays the BatchBuilder Mapping List Screen.
File Filter field and Exclude Filter check box No Enter files to be included or excluded from the batch load file.

If this field is blank, all files in the specified directory and sub-directories are included.

If files are specified in this field and the Exclude Filter check box is clear, only the specified files are included in the batch load file.

If files are specified in this field and the Exclude Filter check box is selected, all files except the specified files are included in the batch load file.

Whole file names or file extensions can be specified.

Separate file names and extensions with a comma.

Extensions can be entered as *.ext, .ext, or ext.

Build button N/A Creates a batch load file using the specified parameters.

A.1.8.3 BatchBuilder Mapping List Screen

The BatchBuilder Mapping List screen is used to create a mapping list for the batch load file. To access this screen, on the BatchBuilder Screen click Edit next to the Mapping field.

BatchBuilder Mapping List screen
Element Description
Name column Lists the available mapping files.
Description column Short description of each mapping file.
Add button Displays the Add BatchBuilder Mapping Screen.
Edit button Displays the Edit BatchBuilder Mapping Screen.
Delete button Deletes the selected mapping file.
Close button Closes the BatchBuilder Mapping List screen.

A.1.8.4 Add BatchBuilder Mapping Screen

The Add BatchBuilder Mapping screen is used to name a new mapping file. To access this screen, on the BatchBuilder Mapping List Screen click Add.

Add BatchBuilder Mapping screen
Element Description
Name field Unique name for the mapping file. Maximum field length is 30 characters. The following are not acceptable: spaces, tabs, linefeeds, carriage returns, and ; ^ ? : @ & + " # % < * ~ |
Description field Short description of the mapping file.
OK button Displays the Edit BatchBuilder Mapping Screen.
Cancel button Closes the Add BatchBuilder Mapping screen without creating a new mapping file.

A.1.8.5 Edit BatchBuilder Mapping Screen

The Edit BatchBuilder Mapping screen is used to edit a mapping file. To access this screen, do one of the following:

Edit BatchBuilder Mapping screen
Element Description
Description field Short description of the mapping file.
Field column Lists metadata fields that have values defined in the mapping file.
Value column Shows the values that will be assigned to the metadata fields in the batch load file.
Add button Displays the Add/Edit BatchBuilder Mapping Field Screen.
Edit button Displays the Add/Edit BatchBuilder Mapping Field Screen.
Delete button Deletes the selected metadata field from the mapping file.
OK button Saves the current settings in the mapping file.
Cancel button Closes the Edit BatchBuilder Mapping screen without applying any changes.

A.1.8.6 Add/Edit BatchBuilder Mapping Field Screen

The Add/Edit BatchBuilder Mapping Field screen is used to define the mapping value for a metadata field. To access this screen, click Add or Edit on the Edit BatchBuilder Mapping Screen.

Add BatchBuilder Mapping Field screen
Element Description
Field field Enter the name of the metadata field to be defined, such as dDocType or xComments.
Value Enter the value to be used in the batch load file. You can type directly in this field or insert predefined variables from the column to the right.
<< button Inserts the variable selected from the right column into the Value field.
Variable column Lists predefined variables you can use as values in the batch load file.
OK button Applies the field and value settings to the mapping file.
Cancel button Closes the Add/Edit BatchBuilder Mapping Field screen without applying any changes.

A.1.9 Content Server Analyzer Interface

The following screens are used to confirm the integrity of the content server repository components, including the file system, database, and search index. It can also assist system administrators in repairing some problems that are detected in the repository components.

The Content Server Analyzer contains two tabs:

The method to start the Content Server Analyzer depends on the operating system:

  • (Windows) Select Start, then Programs, then Oracle Content Server, then instance_name, then Content Server Analyzer.

  • (UNIX/Linux) Change to the DomainHome/ucm/cs/bin directory and run the Content Server Analyzer program.

Surrounding text describes Content Server Analyzer screen.

A.1.9.1 Content Server Analyzer: Configuration Tab

The Configuration tab of the Content Server Analyzer Configuration table is used to configure analysis options and specify a customized logging directory structure:

Option Description
Check database Performs all checks on the database, ensures the integrity of the database columns, and confirms the consistency of data between the DocMeta, Revision, and Documents tables.
Check RevClassIDs Ensures the accurate data synchronization between the dRevClassID and dDocName tables.
Clean database Removes inconsistent rows from the database. Extra entries in the DocMeta table are deleted, inadequately defined entries in the Document table are deleted, and entries without a corresponding reference in the Revisions table are deleted.
Check search index Analyzes the search index to ensure its integrity and checks for duplicate data records for indexed documents and any documents that might be missing from the search collection.
Clean search index Re-indexes the search index and replaces missing data records of any omitted documents.
Check file system Analyzes the file system (weblayout and vault file repositories) to ensure all necessary files are present.
Delete Permanently deletes extra files that were found during the file system analysis.
Safe delete Creates a safe delete directory in the logs/ directory and copies the extra files that were found during the file system analysis into this directory.
Check for extra files Identifies any possible extra files that might be in the file system.
Generate report Uses the console window to report statistics about the content items in the repository. It includes information pertaining to the status, release and processing states of content items in the file system and provides prior and current totals. Progress and error messages are also logged to the console window.
Range Specifies the first and last of the criteria analyze.
Log Directory The default directory used by Content Server Analyzer is DomainHome/ucm/cs/bin/logs/. Optionally, you can also enter a custom directory name. If the Safe delete option is selected, the files are moved to this directory.

A.1.9.2 Content Server Analyzer: Progress Tab

The Progress tab of the Content Server Analyzer displays the progress of the analysis processes and all generated information. To access this tab, click the tab on the Content Server Analyzer Application, or click Start Analysis on the Content Server Analyzer Application.

Element Description
Task progress bar Displays the combined progress of the specific analysis tasks selected on the Configuration tab.
Overall progress bar Displays the overall progress of the analysis process.
Console area Area that displays the information collected and summarized during the analysis processes. Displays applicable information for each selected option. Also displays progress and error messages generated during the analysis processes.
Start Analysis button Starts the content server analysis.

A.1.10 Error and Status Information Interface

This section includes user interface illustrations and reference descriptions for error and status information.

A.1.10.1 Content Server Logs Screen

Content Server log files are listed by date and time. One file is generated for each day. Entries are added to the file throughout the day as events occur. To access this screen, select Administration then Log Files from the portal navigation bar, then select Content Server Logs. To access a specific log file, click a log date and time link on the page.

Log Files for Content Server screen
Content Server Log File screen
Element Description
Type column Displays the type of log file entry:
  • Info: Displays basic status information.

  • Error: Displays errors that occur but do not stop the software from functioning.

  • Fatal: Displays errors that stop the software from functioning.

Time column Displays the date and time of the log file entry.
Description column Displays information about the log file entry. The level of detail depends on the type of entry.

A.1.10.2 Archiver Log Screen

Archiver log files show information about imports, exports, and replications. The log files are listed by date and time. One file is generated for each day. Entries are added to the file throughout the day as events occur To access this screen, select Administration then Log Files from the portal navigation bar, then select Archiver Logs.

Surrounding text describes Log Files for Archiver screen.
Surrounding text describes Archiver Log File screen.
Element Description
Type column Displays the type of log file entry:
  • Info: Displays basic status information.

  • Error: Displays errors that occur but do not stop the software from functioning.

  • Fatal: Displays errors that stop the software from functioning.

Time column Displays the date and time of the log file entry.
Description column Displays information about the log file entry. The level of detail depends on the type of entry.

A.1.10.3 Database Log Screen

Database log files are listed by date and time. One file is generated for each day. Entries are added to the file throughout the day as events occur. To access this screen, select Administration from the portal navigation bar, then Log Files, then Database Logs. To access a specific log file, click a log date and time link on the page.

Surrounding text describes Log Files for Database screen.
Surrounding text describes Database Log File screen.
Element Description
Type column Displays the type of log file entry:
  • Info: Displays basic status information.

  • Error: Displays errors that occur but do not stop the software from functioning.

  • Fatal: Displays errors that stop the software from functioning.

Time column Displays the date and time of the log file entry.
Description column Displays information about the log file entry. For more information, click Details.

A.1.10.4 Configuration Information Page

The Configuration Information Page provides configuration details for a Content Server instance. To access this page, click Administration in the portal navigation bar, then click Configuration for [Instance].

Surrounding text describes Configuration Information screen.
Element Description
Server Name Name of the Content Server. For more information, click Server Configurations.
Version Release and build numbers for the Content Server software.
ClassLoader Type of Classloader. For more information, click Show Classpath Details.
Install Directory Path of the install directory for the Content Server instance. For more information, click Directory Details.
Database Type Name of the type of database configured for use by the Content Server. For more information, click Database Connection Details.
Database Version Version number and type for the database configured for use by the Content Server.
HTTP Server Address Address for the HTTP server for the Content Server. For more information, click Internet Configurations.
Mail Server Specific name for the Content Server mail server (router.companyname.suffix).
Search Engine Name of the search engine configured for use with the Content Server.
Index Engine Name Name of the index engine configured for use with the Content Server.
Active Index Name of the active index.
Number of Installed Features Number of features installed on the Content Server. For more information, click Feature Details.
Number of Enabled Components Number of components installed and enabled on the Content Server. For more information, click Enabled Component Details.
Number of Disabled Components Number of components disabled on the Content Server. For more information, click Disabled Component Details.
Auto Number Prefix Automatically generated prefix number. For more information, click Server Options.
Use Accounts If using accounts on the Content Server, set to True. If not using accounts, set to False.
Ntlm Security Enabled If Ntlm security is enabled, set to True. If Ntlm security is disabled, set to False.
Allow get copy for user with read privilege If users with Read privilege can get a copy of a content item, then set to True. If users with Read privilege can not get a copy of a content item, then set to False. For more information, click Content Security Details.
Allow only original contribute to check out If only the original contributor (user) can check out a content item, then set to True. If users besides the original contributor can check out a content item, then set to False.
Java Version Number of the software version of Java used with the Content Server. For more information, click Java Properties.

A.1.10.5 System Audit Information Page

The System Audit Information page provides audit details for a Content Server instance. To access this page, click Administration in the portal navigation bar, then click System Audit Information.

Surrounding text describes System Audit Information screen.
Surrounding text describes System Audit Information screen.
Element Description
General Information area Provides the following information:
  • Amount of time the Content Server has been up and running.

  • Number of service requests processed, and whether the system is handling services requests successfully.

  • Total JVM memory capacity, and total JVM available memory. For more information, click Memory Details.

  • Total number of threads. For more information, click Thread Details.

  • Total number of active database connections. For more information, click Database Connection Details.

  • Total number of audit messages.

Localization Information area Provides the following information:
  • Number for the string key count.

  • Whether the localization system is using string index.

  • Number for the localization test run time.

  • Number for localization test lookups per second.

Tracing Sections Information area Provides the following information and options:
  • Full Verbose Tracing check box. Select to implement full verbose tracing.

  • Save check box. Select to save the tracing information.

  • Active Sections field, in which to specify the active sections to trace.

  • Event Trap Text field, in which to specify what text to trap in the trace.

  • Add Thread Dump check box. Select to add a thread dump to the trace.

  • Update button to capture the selections made in this area.

  • Reset button to clear the selections made in this area.

Cache Information area Provides the following information:
  • Number of permanently loaded pages and resource files.

  • Number at which cache is temporarily capped.

  • Whether any temporary items are loaded.

  • Total number of distinct search queries being executed. For more information, click Search Cache Details.

  • Total number of items in cache.

  • Total number of items stored in schema cache.

  • Number of bytes used out of number permitted.

  • Buffer Cache Summary. For more information, click Buffer Pool Details.

Configuration Entry Information area Provides the following information:
  • Number of environment keys.

  • Number of overwritten config values.

  • Number of ignored settings.

  • Number of removed settings.

Component Report area Lists server components by name. For details, click the name of a component. Details include a component's location, version number, and status.

A.1.10.6 Environment Packager Page

The Environment Packager is a diagnostic tool that creates a zip file of the desired state directories, log files, and other component and resource directories. To access this page, click Administration on the portal navigation bar, then click Environment Packager.

Surrounding text describes Environment Packager screen.
Element Description
Unix 'etc' Log Directory check box Select this box to include Unix 'etc' log directory information in the zip file.
Server Data State Directory check box Select this box to include the server data State directory information in the zip file.
Search Engine State Directory check box Select this box to include the search engine State directory information in the zip file.
Schema Resources Directory check box Select this box to include the schedule resources directory information in the zip file.
Content Server Logs check box Select this box to include Content Server log information in the zip file.
Archiver Logs check box Select this box to include Archiver log information in the zip file.
Verity Logs check box Select this box to include Verity log information in the zip file.
Database Logs check box Select this box to include database log information in the zip file.
Custom Components Directory check boxes Select All Files to include the custom component directory in the zip file. Select Digests Only to include just the digests for the custom component directory in the zip file.
Classes Directory check boxes Select All Files to include all Classes directory files in the zip file. Select Digests Only to include just the digests for the classes directory in the zip file.
Weblayout Common Directory for Applets check boxes Select All Files to include all weblayout common directory for applets files in the zip file. Select Digests Only to include just the digests for the weblayout common directory for apples files in the zip file.
Layout and Skin Web Resources check boxes Select All Files to include Layout and Skin Web resources in the zip file. Select Digests Only to include just the digests for layout and skin Web resources in the zip file.
wwResourcesDir check boxes Select All Files to include wwResourcesDir in the zip file. Select Digests Only to include just the digests for wwResourcesDir in the zip file.
Start Packaging button Starts the environment packaging process for the selected items.
Reset button Resets the selected items to their default settings.