3 Managing System Processes

This chapter describes concepts and tasks for managing Oracle Content Server system processes on an ongoing basis. It covers the following topics:

3.1 Starting, Stopping, and Restarting Oracle Content Server

There are several methods for starting, stopping, and restarting an Oracle Content Server instance. Which method you choose depends on your requirements, your authorization, and the task you want to complete. For example, when certain configuration changes are made to an Oracle Content Server instance, such as when components are enabled or disabled, the Oracle Content Server instance must be restarted. Available methods include:

  • Oracle WebLogic Server Administration Console

  • Oracle WebLogic Server scripts

  • Oracle Enterprise Manager Fusion Middleware Control

Note:

In earlier releases, the Oracle Content Server Admin Server could be used to start, stop, and restart an Oracle Content Server instance. This functionality has been replaced as of 11g Release 1 (11.1.1), although other functions can still be managed with the Admin Server.

Procedures are described in these topics:

3.1.1 Starting Oracle Content Server

An Oracle Content Server instance is initially started during the process of installing and deploying the instance on an Oracle Universal Content Management (Oracle UCM) server on an Oracle WebLogic Server domain. You might want to start an Oracle Content Server instance at other times, for example, to start an instance after it has been stopped when changing an Oracle Content Server configuration setting.

3.1.1.1 Starting Oracle Content Server with the Oracle WebLogic Server Administration Console

The Oracle WebLogic Server Administration Console is available to Oracle Content Server administrators because they must have administrative privileges to manage the UCM server with the Oracle Content Server instance. The Node Manager must be configured and running in order to start the UCM server with the Oracle Content Server instance.

To start Oracle Content Server with the Oracle WebLogic Server Administration Console:

  1. On the Administration Console Domain Structure navigation bar, select Environment, then Servers.

  2. On the Conversion tab for the Summary of Servers section, select the name of the Oracle UCM server for the Oracle Content Server instance.

  3. In the Settings for server_name section, click the Control tab.

  4. In the Server Status area, click Start.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.1.1.2 Starting Oracle Content Server with Scripts

Scripts provide a quick method to execute actions on Oracle WebLogic servers. Before you can start a Managed Server for an application, you must start the Administration Server for the Oracle WebLogic Server domain.

The following examples assume that the Oracle Content Server instance has been previously started as part of the software installation process. For details, see "Starting the Administration Server" and "Starting Managed Servers" in Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite.

Caution:

These script commands control the Oracle WebLogic Server Managed Server that includes the Oracle UCM server for the Oracle Content Server, and the Oracle WebLogic Server Administration Server, which includes the Administration Console. If you do not want to start or stop the Oracle WebLogic Server Administration Server, then use another method to start the Oracle Content Server instance.

To start Oracle Content Server with scripts:

Run the script to start the Oracle WebLogic Server Administration Console, then the script to start the Oracle WebLogic Server Managed Server with the UCM server with the Oracle Content Server instance (in this example, named UCM_server1):

Windows script:

MW_HOME\user_projects\domains\DOMAIN_HOME\bin\startWebLogic.sh
MW_HOME\user_projects\domains\DOMAIN_HOME\bin\startManagedWebLogic.sh UCM_server1

UNIX script:

MW_HOME/user_projects/domains/DOMAIN_HOME/bin/startWebLogic.sh
MW_HOME/user_projects/domains/DOMAIN_HOME/bin/startManagedWebLogic.sh UCM_server1

For more information on scripts, see Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

3.1.1.3 Starting Oracle Content Server with Fusion Middleware Control

Oracle Enterprise Manager Fusion Middleware Control can be used by administrators to manage multiple domains, including an Oracle WebLogic Server domain running an Oracle Content Server instance. This method of starting an Oracle Content Server instance also provides access to information about the Oracle UCM domain in which the Oracle Content Server instance is deployed.

To start Oracle Content Server with Fusion Middleware Control:

  1. In the Fusion Middleware Control navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

  2. Expand Content Management, then Universal Content Management, then Content Server.

  3. Select the Oracle Content Server name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

  4. From the UCM menu on the Oracle Content Server page, select Control, then Start. The Oracle Content Server instance is started.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.1.2 Stopping Oracle Content Server

The Oracle Content Server instance can be stopped for several reasons, including changing the configuration, such as enabling or disabling a server component.

3.1.2.1 Stopping Oracle Content Server with the Oracle WebLogic Server Administration Console

The Oracle WebLogic Server Administration Console is available to Oracle Content Server administrators because they must have administrative privileges to manage the Oracle Content Server instance. The Node Manager must be configured and running in order to stop the UCM server with the Oracle Content Server instance.

To stop Oracle Content Server with the Oracle WebLogic Server Administration Console:

  1. On the Administration Console Domain Structure navigation bar, select Environment, then Servers.

  2. On the Conversion tab for the Summary of Servers section, select the name of the Oracle UCM server for the Oracle Content Server instance.

  3. In the Settings for server_name section, click the Control tab.

  4. In the Server Status area, click Shutdown.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.1.2.2 Stopping Oracle Content Server with Scripts

Scripts provide a quick method for executing actions on Oracle WebLogic servers.

Caution:

These script commands control the Oracle WebLogic Server Managed Server that includes the Oracle UCM server for the Oracle Content Server, and the Oracle WebLogic Server Administration Server, which includes the Administration Console. If you do not want to start or stop the Oracle WebLogic Server Administration Server, then use another method to stop the Oracle Content Server instance.

To stop Oracle Content Server with Scripts:

Run the script to stop the UCM server with the Oracle Content Server instance (in this example, named UCM_server1) on the Oracle WebLogic Server Managed Server. Next, only if necessary, run the script to stop the Oracle WebLogic Server Administration Console:

Windows script:

MW_HOME\user_projects\domains\DOMAIN_HOME\bin\stopManagedWebLogic.sh UCM_server1
MW_HOME\user_projects\domains\DOMAIN_HOME\bin\stopWebLogic.sh

UNIX script:

MW_HOME/user_projects/domains/DOMAIN_HOME/bin/stopManagedWeblogic.sh UCM_server1
MW_HOME/user_projects/domains/DOMAIN_HOME/bin/stopWebLogic.sh

For more information on scripts, see Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

3.1.2.3 Stopping Oracle Content Server with Fusion Middleware Control

Oracle Enterprise Manager Fusion Middleware Control can be used by administrators to manage multiple domains, including an Oracle WebLogic Server domain running the Oracle Content Server instance. This method of stopping the Oracle Content Server instance also provides access to information about the Oracle UCM domain in which the Oracle Content Server instance is deployed.

To stop Oracle Content Server with Fusion Middleware Control:

  1. In the Fusion Middleware Control navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

  2. Expand Content Management, then Universal Content Management, then Content Server.

  3. Select the Oracle Content Server instance name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

  4. From the UCM menu on the Oracle Content Server page, select Control, then Shut Down.... The Oracle Content Server instance is shut down.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.1.3 Restarting Oracle Content Server

The Oracle Content Server instance can be restarted for several reasons, including changing the configuration, such as enabling or disabling a server component.

3.1.3.1 Restarting Oracle Content Server with the Oracle WebLogic Server Administration Console

The Oracle WebLogic Server Administration Console is available to Oracle Content Server administrators because they must have administrative privileges to manage the Oracle Content Server instance. The Node Manager must be configured and running in order to stop and start the UCM server with the Oracle Content Server instance.

To restart Oracle Content Server with the Oracle WebLogic Server Administration Console:

  1. On the Administration Console Domain Structure navigation bar, select Environment, then Servers.

  2. On the Conversion tab for the Summary of Servers section, select the name of the Oracle UCM server for the Oracle Content Server instance.

  3. In the Settings for server_name section, click the Control tab.

  4. In the Server Status area, click Shutdown.

  5. Confirm that the Oracle Content Server instance has stopped, and then click Start.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.1.3.2 Restarting Oracle Content Server with Scripts

Scripts provide a quick method for executing actions on Oracle WebLogic servers.

Caution:

These script commands control the Oracle WebLogic Server Managed Server that includes the Oracle UCM server for the Oracle Content Server, and the Oracle WebLogic Server Administration Server, which includes the Administration Console. If you do not want to start or stop the Oracle WebLogic Server Administration Server, then use another method to restart the Oracle Content Server instance.

To Restart Oracle Content Server with Scripts:

Run the script to stop the Oracle WebLogic Server Managed Server with Oracle UCM (in this example, named UCM_server1). Next, only if necessary, run the script to stop the Oracle WebLogic Server Administration Server. When the server or servers have stopped, if appropriate run the script to start the Oracle WebLogic Server Administration Server, and finally run the script to start the Oracle WebLogic Server Managed Server with Oracle UCM.

Windows script:

MW_HOME\user_projects\domains\DOMAIN_HOME\bin\stopManagedWeblogic.sh UCM_server1
MW_HOME\user_projects\domains\DOMAIN_HOME\bin\stopWeblogic.sh
MW_HOME\user_projects\domains\DOMAIN_HOME\bin\startWeblogic.sh
MW_HOME\user_projects\domains\DOMAIN_HOME\bin\startManagedWeblogic.sh UCM_server1

UNIX script:

MW_HOME/user_projects/domains/DOMAIN_HOME/bin/stopManagedWeblogic.sh UCM_server1
MW_HOME/user_projects/domains/DOMAIN_HOME/bin/stopWeblogic.sh
MW_HOME/user_projects/domains/DOMAIN_HOME/bin/startWeblogic.sh
MW_HOME/user_projects/domains/DOMAIN_HOME/bin/startManagedWeblogic.sh UCM_server1

For more information on scripts, see Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

3.1.3.3 Restarting Oracle Content Server with Fusion Middleware Control

Oracle Enterprise Manager Fusion Middleware Control can be used by administrators to manage multiple domains, including an Oracle WebLogic Server domain running an Oracle Content Server instance. This method of stopping and starting the Oracle Content Server instance also provides access to information about the Oracle UCM domain in which the Oracle Content Server instance is deployed.

To restart Oracle Content Server with Fusion Middleware Control:

  1. In the navigation tree, expand the appropriate domain name (for example, UCM_ucm_domain).

  2. Expand Content Management, then Universal Content Management, then Content Server.

  3. Select the Oracle Content Server instance name (for example, Oracle Content Server (UCM_server1)). The home page for your Oracle Content Server instance displays.

  4. From the UCM menu on the Oracle Content Server page, select Control, then Shut Down....

  5. Confirm that the Oracle Content Server instance is shut down.

  6. From the UCM menu on the Oracle Content Server page, select Control, then Start. The Oracle Content Server instance is started.

For more information, see "Starting and Stopping Oracle WebLogic Server Instances" in Oracle Fusion Middleware Administrator's Guide.

3.2 Accessing Oracle Content Server With a Browser

To access a running Oracle Content Server instance, start a web browser and enter the following URL:

http://managedServerHost:managedServerPort/cs

For managedServerHost, specify the name of the computer that hosts the Oracle WebLogic Server Managed Server for the Oracle Universal Content Management (Oracle UCM) domain where the Oracle Content Server instance is installed. For managedServerPort, specify the listen port number for the Oracle WebLogic Server Managed Server for the Oracle UCM domain where the Oracle Content Server instance is installed.

Log in with the administrator user name and password for Oracle WebLogic Server. The default port number for Oracle UCM with the Oracle Content Server instance is 16200. For example:

http://myHost.example.com:16200/cs

3.3 Managing Oracle Content Server With the Admin Server

This section includes the following topics:

3.3.1 About the Admin Server

The Oracle Content Server Admin Server is a collection of web pages that enable you to configure system-wide settings for the Oracle Content Server instance. If you use the Admin Server, keep the following restrictions in mind:

  • You must be logged in as the system administrator or a user with the sysmanager role to access the Admin Server.

  • To administer the Oracle Content Server instance with the Admin Server, the instance must be accessible on the local file system. The drive on which any remote instance is installed must be mapped or mounted to the local drive.

  • The Admin Server must run on the same file system as the Oracle Content Server instance that it administrates.

  • Previous to 11g Release 1 (11.1.1), the Admin Server could be used to start, stop, and restart the Oracle Content Server instance. By default those functions are now managed through the Oracle WebLogic Server Administration Console or Fusion Middleware Control. See Section 3.1, "Starting, Stopping, and Restarting Oracle Content Server."

3.3.2 Viewing Server Output

To view the Java output of the Oracle Content Server instance Admin Server:

  1. Display the Admin Server Page.

  2. Click the View Server Output link.

    The Admin Server Output Page is displayed.

  3. To refresh the output messages, click Refresh. To clear the output messages, click Clear.

3.4 Starting Oracle Content Server Administration Applications

You can run Content Server administration applications either as applets or in standalone mode. Running applications in standalone mode requires additional configuration for database connections.

3.4.1 Running Administration Applications as Applets

You can run several of the Oracle Content Server administration applications as applets from any web browser with access to the Oracle Content Server instance. Applets are convenient for remote administration.

Note:

The Batch Loader, Component Wizard, System Properties, and Content Server Analyzer utilities cannot be run as applets; for security reasons, they must be run in standalone mode from the computer where the Oracle Content Server instance is deployed. For details, see "Running Administration Applications in Standalone Mode".

Some functions that are available in the standalone version of an application are not available from the applet version. See the documentation for each application for more information.

To run an administration application as a Java applet within a Java-enabled browser:

  1. Open a browser window.

  2. Log in to the Oracle Content Server instance as an administrator.

  3. Select Administration in the portal navigation bar.

  4. Select Admin Applets.

  5. Select an administration application from the list of applets.

3.4.2 Running Administration Applications in Standalone Mode

You can run several Oracle Content Server administration Java applications in standalone mode from the computer where an Oracle Content Server instance is deployed. Some of the applications are the same as the applets accessed using a web browser, such as Configuration Manager and Repository Manager. Some applications can only run in standalone mode, such as System Properties and Batch Loader. .

Running the standalone version of an application offers greater security than browser applets, and enables you to send passwords without having them captured or copied from the web or a network.

Important:

Before you can run Oracle Content Server administration applications in standalone mode, additional configuration is required to authenticate the applications on Oracle WebLogic Server and to have a JDBC connection to the system database and access to the Oracle WebLogic Server database connection. See "Configuring a SystemDatabase Provider for Standalone Mode" and "Configuring an External Database Provider for Standalone Mode".

If a standalone application is required to connect to an SSL-enabled database where digital certificates are used for authentication, then the database root CA certificate must be imported into the standard Java key store that the application uses to check trusted sources. For configuration details, see "Importing a Database Root CA Certificate into the Key Store for a Standalone Application" in Oracle Fusion Middleware Installation Guide for Oracle Enterprise Content Management Suite.

3.4.2.1 Configuring a SystemDatabase Provider for Standalone Mode

Oracle Content Server administration applications and utilities that can only run in standalone mode require specific configuration to run in an Oracle WebLogic Serverdomain with Oracle UCM and an Oracle Content Server instance. The configuration changes for a standard (non-customized) Oracle WebLogic Server connection are necessary to have the applications authenticate Oracle WebLogic Server users and to set up a JDBC connection to the Oracle WebLogic Server system database.

To configure Oracle WebLogic Server system database connections:

  1. As system administrator, use VNC (or a similar tool such as putty or Xming) to navigate to the DOMAIN_HOME/ucm/cs/bin directory. For example:

    MW_HOME/user_projects/domains/ucm_domain/ucm/cs/bin
    
  2. Run ./SystemProperties. The System Properties window is displayed.

  3. On the Paths tab, the Specify Database Driver Classpath checkbox is selected by default, so you must enter a path to a JDBC driver for your system database in the Database Driver Classpath field. The Oracle driver ojdbc6dms.jar is provided with the Enterprise Content Management install in the following directory.

    MW_HOME/oracle_common/modules/oracle.jdbc_11.1.1/ojdbc6dms.jar
    
  4. On the Database tab, enter all the necessary JDBC connection information in the fields for your system database (database type, database user name, database user password, and so on).

  5. Click OK.

    You should now be able to run a standalone application. For example, as the Administrator user you created on the Oracle Content Server instance, run ./BatchLoader.

3.4.2.2 Configuring a JDBC Database Driver for Standalone Mode

For the Oracle Content Server system to work with applications that only run in standalone mode, such as the Batch Loader utility, you must configure a JDBC driver for the system database or an external database provider. Oracle Fusion Middleware DataDirect JDBC drivers for SQL Server and DB2 databases are available to support Oracle Content Server standalone applications. You can use the SystemProperties utility to enter the configuration information.

  1. As system administrator, run ./SystemProperties from the bin directory for the Oracle Content Server instance.

    • UNIX path: DOMAIN_HOME/ucm/cs/bin/SystemProperties

    • Windows path: DOMAIN_HOME\ucm\cs\bin\SystemProperties

    The SystemProperties utility starts.

  2. On the System Properties page, click the Database tab, where you can select the appropriate driver and enter the connection string, user name, and password.

    You do not need to enter a classpath or driver name, or copy any jar files.

    You can find JDBC connection string and user name information in the Oracle WebLogic Server Administration Console. Log in to the Administration Console, then select Services, then Data Sources, then CSDS (or URMDS), and then Connection Pool. On the Connection Pool tab, the connection string is in the URL field, and the user name is in the Properties field. For security, the password is not displayed.

  3. On the Database tab, select the appropriate driver under Use Java Database Connectivity, and enter the connection string.

    • For Microsoft SQL Server, select DataDirect SQL Server JDBC Driver, and enter a connection string of this form:

      jdbc:weblogic:sqlserver://database_hostname:database_port_number;databaseName=database_name
      
    • For IBM DB2, select DataDirect DB2 JDBC Driver, and enter a connection string of this form:

      jdbc:weblogic:db2://database_hostname:database_port_number;databaseName=database_name
      
  4. Enter the user name and password for the database in the JDBC User Name and JDBC User Password fields.

  5. Click OK.

  6. Restart the Oracle Content Server instance.

3.4.2.3 Configuring an External Database Provider for Standalone Mode

You can create an external database provider in the Oracle Content Server instance for standalone applications to directly connect to a database with JDBC without using the SystemDatabase provider for the Oracle WebLogic Server data source.

For standalone applications to use the OracleTextSearch feature, you must configure the external database provider to include the JDBC connection information.

By default, the configuration of an incoming provider does not include values for JDBC Driver and JDBC Connection String. You must add these values, but be careful not to change the provider name because you cannot rename an existing provider. To change the name of a provider, you would need to delete it and then add it again.

3.4.2.4 Running a Standalone Application on a UNIX System

Follow these steps to run an Oracle Content Server administration application in standalone mode on a UNIX operating system:

  1. Navigate to the DomainHome/ucm/cs/bin/ directory. Executable applications are listed.

  2. Enter ./application_name, where application_name is the name of an executable file. If an application is not listed, it can be entered as a parameter to the IntradocApp application, as in this example:

    DomainHome/bin/intradocApp workflow
    
  3. Press Enter.

    For all applications except for Component Wizard and System Properties, a login screen is displayed. For Component Wizard and System Properties, the main screen of the application is displayed.

  4. Enter the administrator login name and password.

  5. Click OK.

    The main screen of the application is displayed.

3.4.2.5 Running a Standalone Application on a Windows System

Follow these steps to run an Oracle Content Server administration application in standalone mode on a Windows operating system:

  1. Select the application from the Windows Start menu:

    • To run an administration application, from the Start menu select Programs, Content Server, Oracle Content Server-instance, Applications, and then the application.

    • To run an administration utility, from the Start menu select Programs, Content Server, Oracle Content Server-instance, Utilities, then the utility.

    For all applications except for Component Wizard and System Properties, a login screen is displayed. For Component Wizard and System Properties, the main screen of the application is displayed. It may take several seconds for the login screen or the application screen to appear, or the screen may be hidden by other windows.

  2. Enter the administrator login name and password.

  3. Click OK.

    The main screen of the application is displayed.

3.5 Using the IdcShell Command-Line Tool

The IdcShell tool enables administrators to run Idoc Script from a command line. Idoc Script is a proprietary server-side scripting language.

The IdcShell tool also includes some additional Idoc Script functions, listed in Table 3-1, and some dynamichtml definitions, listed in Table 3-2, which are useful for managing a Content Server or Inbound Refinery instance.

The IdcShell tool has built-in help, which you can access by running the command:

bin/IdcShell "include shell_help"

Table 3-1 Command-Line Idoc Script Functions

Function Description

doService(serviceName)

Executes a serviceName in the current context.

formatBinder()

Formats a DataBinder for easy reading.

getWithTrace()

Traces the get() function and reports on the source of the data.

promptUser(text, flags)

Displays text on the console and reads a user response. If flags is NO_ECHO, then it does not echo input.


Table 3-2 Dynamichtml Definitions

Dynamichtml definition Description

get_username

Prompts for a user name on the console and assigns to userName.

get_password

Prompts for a password on the console and assigned to dPassword.

set_user_password

Sets a user's password.

create_user

Creates a new user, by default with Admin role.


3.6 Batch Loading Content

This section covers these topics:

3.6.1 About Batch Loading

This section describes how to use the Batch Loader utility to check in (insert), delete, or update a large number of files on your Oracle Content Server system simultaneously. The Batch Loader can save you time and effort by automating the batch loading process. The following are examples of when to use the Batch Loader:

  • You just purchased the Oracle Content Server software, and you want check in all of your existing files with metadata that exists in a database.

  • You have documents checked into the Oracle Content Server repository, and you just created a new custom metadata field. You can use the Batch Loader to add the values you specify for the new metadata field to each existing content item.

  • You want to remove a large number of specific files from the system.

Note:

For the Batch Loader utility to function correctly with an Oracle WebLogic Server instance, you must have JDBC connection settings configured. See Section 3.4.2, "Running Administration Applications in Standalone Mode."

The Batch Loader performs actions that are specified in a batch load file, which is a text file that describes the action to perform and the metadata for each content item in the batch.

A batch load file is a text file that tells the Batch Loader which actions to perform and what metadata to assign to each content item in the batch.

This section covers these topics:

3.6.1.1 File Records

A batch load file is made up of file records, which are sets of name/value pairs that specify the action to perform, or the metadata for individual content items, or both.

Important:

Field names and parameters are case sensitive. They must appear in the batch load file exactly as they appear in the following sections. For example, dDocName is not the same as ddocname, dDocname, or DDOCNAME.
  • Each file record ends with an <<EOD>> (end of data) marker.

  • A pound sign (#) followed by a space at the beginning of a line indicates a comment. The comment character must be followed by a space. For example: # primaryFile=test.txt works properly, but #primaryFile=test.txt will cause errors.

  • The following is an example of a file record:

    # This is a comment
    Action=insert
    dDocName=Sample1
    dDocType=Document
    dDocTitle=Batch Load record insert example
    dDocAuthor=sysadmin
    dSecurityGroup=Public
    primaryFile=links.doc
    dInDate=8/15/2001
    <<EOD>>
    

3.6.1.2 Actions

Valid actions for batch loading are Insert, Delete, and Update.

  • If no action is specified for a file, the system tries to perform an update.

  • Each file record can have only one action, but file records with different actions can be present in the same batch load file.

  • The logic process for each action is different.

3.6.1.3 Insert

The insert action checks a new file into the Oracle Content Server repository. If the Content ID (dDocName) already exists in the Oracle Content Server database, no action is performed.Figure 3-1 illustrates the insert action.

Figure 3-1 The Insert Action Sequence for Checking In a New File

Description of Figure 3-1 follows
Description of "Figure 3-1 The Insert Action Sequence for Checking In a New File"

3.6.1.3.1 Insert Requirements

The following table defines the fields required for successful performance of an insert action.

Note:

Batch loaded revisions will not enter a workflow even if they meet the criteria for an active workflow.
  • Field Length: Maximum number of characters permitted in the field.

  • Carried Over: If the next record does not contain this field, the value of this field will be taken from the previous record.

    Important:

    If you have defined any custom metadata fields as required fields, those fields also need to be defined for an insert action.
    Required Items Field Length Carried Over Definition
    Action=insert N/A Yes The command to insert a file.

    The term Action is case sensitive and must be initial capitalized.

    dDocName 30 No The metadata field named Content ID.
    dDocType 30 Yes The metadata field named Type.
    dDocTitle 80 No The metadata field named Title.
    dDocAuthor 30 Yes The metadata field named Author.
    dSecurityGroup 30 Yes The metadata field named Security Group.
    primaryFile N/A N/A The metadata field named Primary File. The Primary File name can be a complete path or just the file name. If a file name only is specified, the location of the file is determined as follows:
    • If the SetFileDir optional parameter has been set in this file record or any previous file record, the directory specified in SetFileDir will be used.

    • If the SetFileDir parameter has not been set, the batch load file path is used. (The path is specified in the Batch Load File field on the Batch Loader Screen.)

    dInDate N/A No The metadata field named Release Date.
    • The dInDate must use the date format of the locale of the user executing the Batch Loader. For example, the US English date format is mm/dd/yy hh:mm:ss am/pm.

    • Time information is optional. If you specify the time, only the hh:mm part is required. The ss and am/pm parts are optional.

    <<EOD>> N/A N/A Indicates the end of data for the file record.

3.6.1.3.2 Insert Example

The following code fragments show the batch load file syntax for inserting files. This example shows two file records.

The first file record includes all required fields and the action statement, Action=insert. The second file record does not list the required fields dDocType, dDocAuthor, or dSecurityGroup. However, the information for these items is taken from the previous record. Also, the second record does not specify an action, so the insert action is carried over. Therefore, if the Content ID HR003 does not exist, the file will be inserted. However, if the Content ID does exist, it will not be inserted because the action is insert and not update.

  • First record:

    Action=insert
    dDocName=HR001
    dDocType=Form
    dDocTitle=New Employee Information Form
    dDocAuthor=Olson
    dSecurityGroup=Public
    primaryFile=hr001.doc
    dIndate=3/15/97
    <<EOD>>
    
  • Second record:

    dDocName=HR003
    dDocTitle=Performance Review
    primaryFile=hr003.doc
    dIndate=3/15/97
    <<EOD>>
    

3.6.1.4 Delete

The delete action deletes one or all revisions of an existing file from the Oracle Content Server repository. If the specified Content ID (dDocName) does not exist in the Oracle Content Server database, no action is performed. Figure 3-2 illustrates the delete action.

Figure 3-2 The Delete Action Sequence

Description of Figure 3-2 follows
Description of "Figure 3-2 The Delete Action Sequence"

3.6.1.4.1 Delete Requirements

The following table defines the fields required for successful performance of a delete action.

Required Items Definition
Action=delete The command to delete a file.

The term Action is case sensitive and must be initial capitalized.

dDocName The metadata field named Content ID.
<<EOD>> Indicates the end of data for the file record.

3.6.1.4.2 Delete Example

The following example shows the batch load file syntax for deleting files. This example shows two file records. The first file record will delete all revisions of the Content ID HR001. The second file record will delete revision 2 of the content item HR002.

Action=delete
dDocName=HR001
<<EOD>>
Action=delete
dDocName=HR002
dRevLabel=2
<<EOD>>

3.6.1.5 Update

The update action updates existing content items. One of the following actions occurs, depending on what items are present in the file record and what content exists in the system:

  • A new revision of an existing content item is created.

  • An existing file's metadata is updated.

  • A new content item is inserted (Action=insert is performed).

    Note:

    Batch loaded revisions will not enter a workflow even if they meet the criteria for an active workflow.

A new revision is created when one of the following scenarios occur:

Scenario Content ID (dDocName) Revision (dRevLabel) Release Date in Batch Load file (dInDate)
Scenario 1 Exists in Oracle Content Server instance Not specified in the batch load file. After the release date of the latest revision of the file in the system.
Scenario 2 Exists in Oracle Content Server instance Specified in the batch load file, but does not exist in the Oracle Content Server instance. After the release date of the latest revision of the file in the system.

Figure 3-3 The Update Action Sequence

Description of Figure 3-3 follows
Description of "Figure 3-3 The Update Action Sequence"

3.6.1.5.1 Update Requirements

The following table defines the fields required for successful performance of an update action.

Required Items Field Length Carried Over Definition
Action=update N/A Yes The command to update a file.

The term Action is case sensitive and must be initial capitalized.

dDocName 30 No The metadata field named Content ID.
dDocType 30 Yes The metadata field named Type.
dDocTitle 80 No The metadata field named Title.
dDocAuthor 30 Yes The metadata field named Author.
dSecurityGroup 30 Yes The metadata field named Security Group.
primaryFile N/A N/A The metadata field named Primary File.

If only the metadata is being updated, the primaryFile field is not required but dRevLabel is required.

If the optional dRevLabel field is specified and matches a revision label that exists in the Oracle Content Server instance, the primaryFile field is not required; the primary file specified for that revision is used.

It is important to note that although dRevLabel is not a required field, if the primaryFile is not present, then dRevLabel becomes a required field.

The Primary File name can be a complete path or just the file name. If a file name only is specified, the location of the file is determined as follows:

  • If the SetFileDir optional parameter has been set in this file record or any previous file record, the directory specified in SetFileDir will be used.

  • If the SetFileDir parameter has not been set, the batch load file path is used. (The path is specified in the Batch Load File field on the Batch Loader Screen.)

dInDate N/A No The metadata field named Release Date.
  • The dInDate must use the date format of the locale of the user executing the Batch Loader. For example, the US English date format is mm/dd/yy hh:mm:ss am/pm.

  • Time information is optional. If you specify the time, only the hh:mm part is required. The ss and am/pm parts are optional.

<<EOD>> N/A N/A Indicates the end of data for the file record.

3.6.1.5.2 Update Example 1

This example assumes that two files are already checked into the system with the following metadata:

  • HR001 has a Release Date of 9/26/98 and Revision of 1

  • HR002 has a Release Date of 3/15/99 and Revision of 2

The first file record, Content ID HR001, exists in the system, but it does not have a Revision (dRevLabel) specified in the batch load file. Therefore, the Batch Loader will compare the Release Date of the latest revision in the system with the Release Date specified in the batch load file. Since 2/20/99 is after 9/26/98, a new revision 2 for HR001 is added.

The second file record, Content ID HR002, exists in the system and has a Revision (dRevLabel) specified, but Revision 3 does not exist in the system. Therefore, a new revision 3 for HR002 is added.

Action=update
dDocName=HR001
dDocType=Form
dDocTitle=New Employee Form
dDocAuthor=Olson
dSecurityGroup=Public
primaryFile=hr001.doc
DInDate=2/20/99
<<EOD>>
dDocName=HR002
dDocTitle=Payroll Change Form
primaryFile=hr002.doc
DIndate=2/20/99
dRevLabel=3
<<EOD>>
3.6.1.5.3 Update Example 2

This example assumes that one file is already checked into the system with the following metadata:

  • Content ID = HR003

  • Release Date = 3/15/97

  • Revision = 1

  • Title = Performance Review

  • Author = Smith

Because Revision 1 of the Content ID HR003 exists in the system (and is not in an active workflow), the revision will be updated with the new Title, Author, and Release Date metadata.

Action=update
dDocName=HR003
dDocType=Form
dDocTitle=Performance Review Template
dDocAuthor=Smith
primaryFile=hr003.doc
dIndate=2/20/99
dRevLabel=1
<<EOD>>

3.6.1.6 Optional Parameters

The following table lists the optional parameters you can use in any file record in a batch load file.

In a batchload file, there are two methods you can use to override the primary and alternate formats assigned to a content item checkin:

  • Specifying a value for the primaryFile:format parameter, or specifying a value for the alternateFile:format parameter, both. However, it is possible to override these values by using the primaryOverrideFormat or alternateOverrideFormat parameters. It is also possible that certain components will force specific formats on certain types of checkins or certain application functionality may exist in some components that forces a different format.

  • Specifying a value for the primaryOverrideFormat parameter, or specifying a value for the alternateOverrideFormat parameter, or both. However, these will only work as parameters in the batch load file if you enable the IsOverrideFormat configuration variable. Note that using this method will override any values that you set for the primaryFile:format and alternateFile:format parameters.

    Optional Parameters Definition
    dRevLabel The metadata field named Revision.

    Maximum field length is 10 characters.

    Values must be an integer or comply with the Major/Minor Revision Label Sequence established by the System Properties settings (see Section 4.1.2, "Configuring General Options").

    dDocAccount The metadata field named Accounts.

    Maximum field length is 30 characters.

    This field is not carried over to the next file record.

    Do not specify this field if accounts are not enabled.

    If accounts are enabled and this field is not specified, dDocAccount will be set to an empty value.

    xComments The metadata field named Comments. Maximum field length is 255 characters.
    dOutDate The metadata field named Expiration Date.

    The dOutDate must use the date format of the locale of the user executing the Batch Loader. For example, the English-US date format is mm/dd/yy hh:mm:ss am/pm.

    Time information is optional. If you specify the time, only the hh:mm part is required. The ss and am/pm parts are optional.

    primaryFile:path Specifies the location of the file. If a primaryFile:path value is specified, the value overrides the value specified for the primaryFile parameter. However, the primaryFile:path value is not used to determine the file conversion format. If a value for primaryFile:path is not specified, the location is determined from the primaryFile value.

    This parameter uses the following syntax:

    primaryFile:path=complete_path

    primaryFile:format Specifies the file format to use for the Primary File. This file format overrides the one specified by the file extension of the file and the value specified for the primaryFile parameter. If a primaryFile:format value is not specified, the file format is determined from the file extension for the primaryFile value.

    This parameter uses the following syntax:

    primaryFile:format=application/conversion_type

    alternateFile The metadata field named Alternate File. The Alternate File name can be a complete path or just the file name. If a file name only is specified, the location of the file is determined as follows:

    If the SetFileDir optional parameter has been set in this file record or any previous file record, the directory specified in SetFileDir will be used.

    If the SetFileDir parameter has not been set, the batch load file path is used. (The path is specified in the Batch Load File field on the Batch Loader Screen.)

    alternateFile:path Specifies the location of the alternate file. If an alternateFile:path value is specified, the value overrides the value specified for the alternateFile parameter. However, the alternateFile:path value is not used to determine the file conversion format. If an alternateFile:path value is not specified, the location is determined from the alternateFile parameter, if a value is specified. Otherwise, by default, the primaryFile value is used for the computation.

    This parameter uses the following syntax:

    alternateFile:path=complete_path

    alternateFile:format Specifies the file format to use for the Alternate File. This file format overrides the one specified by the file extension of the file and the value specified for the alternateFile parameter. If an alternateFile:format value is not specified, the file format is determined from the file extension for the alternateFile parameter, if a value is specified. Otherwise, by default, the primaryFile value is used for the computation.

    This parameter uses the following syntax:

    alternateFile:format=application/conversion_type

    webViewableFile The webViewableFile name can be a complete path or just the file name. If a webViewableFile value is specified, then the conversion process is not performed. If a file name only is specified, the location of the file is determined as follows:

    If the SetFileDir optional parameter has been set in this file record or any previous file record, the directory specified in SetFileDir will be used.

    If the SetFileDir parameter has not been set, the batch load file path is used. (The path is specified in the Batch Load File field on the Batch Loader Screen.)

    webViewableFile:path Specifies the location of the web viewable file. If a webViewableFile.path value is specified, the value overrides the value specified for the webViewableFile parameter. However, the webViewableFile:path value is not used to determine the file conversion format. If a webViewableFile:path value is not specified, the location is determined from the webViewableFile parameter, if a value is specified. Otherwise, by default, the primaryFile value is used for the computation.

    This parameter uses the following syntax:

    webViewableFile:path=complete_path

    webViewableFile:format Specifies the file format to use for the web viewable file. This file format overrides the one specified by the file extension of the file and the value specified for the webViewableFile parameter. If a webViewableFile:format value is not specified, the file format is determined from the file extension for the webViewableFile parameter, if a value is specified. Otherwise, by default, the primaryFile value is used for the computation.

    This parameter uses the following syntax:

    alternateFile:format=application/conversion_type

    primaryOverrideFormat Specifies which file format to use for the Primary File. This file format overrides the one specified by the file extension of the file. This option will only work as a parameter if you enable the IsOverrideFormat configuration variable. You can set this variable by selecting the Allow Override Format in the System Properties application. However, a better (and recommended) alternative would be to use the primaryFile:format parameter.
    alternateOverrideFormat Specifies which file format to use for the Alternate File. This file format overrides the one specified by the file extension of the file. This option will only work as a parameter if you enable the IsOverrideFormat configuration variable. You can set this variable by selecting the Allow Override Format in the System Properties application. However, a better (and recommended) alternative would be to use the alternate File:format parameter.
    SetFileDir Specifies the directory where the Primary Files and Alternate Files are located. This field is carried over to the next file record.

3.6.1.7 Custom Metadata Fields

Any custom metadata field that has been defined in the Configuration Manager can be included in a file record.

  • If you have defined any custom metadata fields as required fields, those fields must be defined for an insert action or an update action.

  • If a custom metadata field is not a required field, but it has a default value (even if blank), then the default value will be used if the value is not specified in the batch load file.

  • When specifying a custom metadata field value, the field name preceded with an x. For example, if you have a custom metadata field called Location, then the batch load file entry will be xLocation=value.

  • Keep in mind that some add-on products use custom metadata fields. For example, if you have PDF Watermark, you will have created a field called Watermark. To include this field in a batch load file, precede it with an x just like any other custom metadata field (that is, xWatermark).

3.6.2 Preparing a Batch Load File

This section covers these topics:

3.6.2.1 About Preparing a Batch Load File

You can use any method you prefer to create a batch load file, if the resulting text file conforms to the batch load file syntax requirements. However, the Batch Loader provides a tool called the BatchBuilder to assist you in creating batch load files.

  • The BatchBuilder creates a batch load file based on the files in a specified directory. The BatchBuilder reads recursively through all the sub-directories to create the batch load file.

  • A mapping file tells the BatchBuilder how to determine the metadata for each file record. You can use the BatchBuilder to create and save custom Mapping Files.

  • You can run the BatchBuilder from the standalone application interface or from the command line.

  • The BatchBuilder can also be used to create external collections of content, which are indexed and stored in a separate search collection rather than in the Oracle Content Server database. You can set up read-only external collections, where users can search for content but cannot update metadata or delete content. This option is recommended when external content is also included in another Oracle Content Server instance.

3.6.2.2 Mapping Files

Mapping files are text files that have a .hda extension, which identifies them as a type of data file used by the Oracle Content Server instance.

See Oracle Fusion Middleware Developer's Guide for Oracle Universal Content Management for more information on HDA files, LocalData properties, and ResultSets.

3.6.2.2.1 Mapping File Formats

The metadata mapping can be defined in one of two formats:

  • As name/value pairs in a LocalData definition, a mapping file would look like the following:

    @Properties LocalData
    dDocName=<$filename$>.<$extension$>
    dInDate=<$filetimestamp$>
    @end
    
  • As a BatchBuilderMapping ResultSet, a mapping file would look like the following:

    @ResultSet SpiderMapping
    2
    mapField
    mapValue
    dDocName
    <$filename$>.<$extension$>
    dInDate
    <$filetimestamp$>
    @end
    
3.6.2.2.2 Mapping File Values

The following values can be used in a mapping file:

Value Description Example
Normal string All files will have the specified metadata value. dDocType=Document

All files will be the Document content type.

Idoc script Any supported Idoc script. For more information, see Oracle Fusion Middleware Idoc Script Reference Guide. xLanguage=<$if strEquals(dir2, "EN")$>English<$elseif strEquals(dir2, "SP")$>Spanish<$else$>French<$endif$>
<$dir1$>, <$dir2$> The directory name at the specified level in the file's path. <$dir1$> refers to the root directory specified in the "Directory" field, <$dir2$> refers to the next level directory, and so on.
dDocType=<$dir1$>
dSecurityGroup=<$dir2$>
dDocAccount=<$dir3$>
If the file path is "f:/docs/public/sales/march.doc" and you have specified the "Directory" value as "f:/docs", the values would be:
<$dir1$> = "docs"
<$dir2$> = "public"
<$dir3$> = "sales"
<$dUser$> The user currently logged in.
dDocAuthor=<$dUser$>
If "administrator" is logged in, then <$dUser$> would equal "administrator".
<$extension$> The file extension of the file.
dDocTitle=<$filename$>.<$extension$>
If the file path is "d:/salesdocs/sample.doc", then <$extension$> would equal "doc".
<$filename$> The name of the file.
dDocName=<$filename$>
If the file path is "d:/salesdocs/sample.doc", then <$filename$> would equal "sample".
<$filepath$> The entire directory path of the file, including the file name.
xPath=<$filepath$>
If the file path is "c:/docs/public/acct/sample.doc", then <$filepath$> is "c:/docs/public/acct/sample.doc".
<$filesize$> The size of the file (in bytes).
xFileSize=<$filesize$>
For a 42KB file, <$filesize$> would be 43008.
<$filetimestamp$> The date and time the file was last modified.
dInDate=<$filetimestamp$>
If the last modified date is September 13, 2001 at 4:03 pm, then <$filetimestamp$> would equal "9/13/01 4:03 PM" for an English-US locale.
<$URL$> The URL of the file, based on the values of the physical file root and relative web root.  

3.6.2.3 Creating a Batch Load File from the BatchBuilder Screen

Use the following procedure to create a batch load file from the BatchBuilder screen:

  1. Start the BatchLoader utility:

    Windows operating system: Select Start, the Programs, then Oracle Content Server, then instance_name, then Utilities, then BatchLoader.

    UNIX operating system: Change to the DomainHome/ucm/cs/bin/ directory, type BatchLoader in a shell window, and press the RETURN key.

    The login screen is displayed.

  2. Enter the Oracle Content Server administrator user name and password, then click OK.

    The Batch Loader Screen is displayed.

  3. Select Options, Build Batch File.

    The BatchBuilder Screen is displayed.

  4. In the Directory field, enter the location of the files to be included in the batch load file.

  5. In the Batch Load File field, enter the path and file name for the batch load file. You can click the Browse button to navigate to and select the directory and file.

  6. From the Mapping list, select a mapping file. To create a new mapping file or edit an existing one, see Section 3.6.2.4, "Creating a Mapping File."

  7. Optional: In the File Filter field, enter filter settings to include or exclude particular files from the batch load file.

  8. Optional: To batch load a read-only external collection, select External, and select the external collection options.

  9. Click Build.

  10. When the build process is complete, click OK.

  11. Open the batch load file in a text editor and double-check the file records.

  12. To save the current batch load file settings as the default, select Options, then Save Configuration.

3.6.2.4 Creating a Mapping File

Use the following procedure to create a mapping file.

  1. Display the BatchBuilder Screen.

  2. Click Edit next to the Mapping field.

    The BatchBuilder Mapping List Screen is displayed.

  3. Click Add.

    The Add BatchBuilder Mapping Screen is displayed.

  4. Enter a name and description for the mapping file, and click OK.

    The Edit BatchBuilder Mapping Screen is displayed.

  5. Click Add.

    The Add/Edit BatchBuilder Mapping Field Screen is displayed.

  6. Enter a metadata field name to be defined. For example, enter dDocName for the Content ID field, or xComments for the Comments field.

  7. Enter the value for the metadata field.

    • Type any constant text and Idoc script directly in the Value field. For example, to set Document as the Type for all documents in the batch load file, enter dDocType in the Field field, and enter Document in the Value field. See the Oracle Fusion Middleware Idoc Script Reference Guide for more information on Idoc Script.

    • To add a predefined variable to the Value field, select the variable in the right column and click the << button. For example, to set each document's second-level directory as the Security Group, enter dSecurityGroup in the Field field, and insert the <$dir1$> variable in the Value field.

      Caution:

      Be careful when choosing predefined variables. Many metadata fields have length limitations and cannot contain certain characters (such as spaces or punctuation marks). See "Managing Repository Content" in the Oracle Fusion Middleware Application Administrator's Guide for Content Server for more information.
  8. Click OK.

  9. Repeat steps 4 through 8 for as many metadata fields as you want to define.

  10. Click OK to save changes and close the Edit BatchBuilder Mapping screen.

    The mapping file is saved as MapFileName.hda in the IntradocDir/search/external/mapping/ directory.

  11. Click Close to close the BatchBuilder Mapping List screen.

3.6.2.5 Creating a Batch Load File from the Command Line

You can create a batch load file by entering the BatchBuilder parameters from a command line rather than entering them in the BatchBuilder screen. Use the following procedure to create a batch load file from the command line:

  1. Open the DomainHome/ucm/cs/bin/intradoc.cfg file in a text editor, and add the following line, where sysadmin is the user name of the Oracle Content Server system administrator:

    BatchLoaderUserName=sysadmin
    

    This is required so that the system logs in as the system administrator, because only users who have admin rights have permission to run the Batch Loader and BatchBuilder applications.

  2. Save and close the file.

  3. Open a command line window and change to the DomainHome/ucm/cs/bin/ directory.

    Caution:

    Run the BatchBuilder using the same operating system account that runs the Oracle Content Server instance. Otherwise, the software might not process your data due to permissions problems.
  4. Enter the following command:

    Win32:

    BatchLoader.exe /spider /q /ddirectory /mmappingfile /nbatchloadfile
    

    UNIX:

    BatchLoader -spider -q -ddirectory -mmappingfile -nbatchloadfile
    

The following flags can be used with the BatchLoader command to run the BatchBuilder from the command line:

Flag Required? Description
-spider or /spider Yes Runs the BatchBuilder application.
-q or /q No Runs the BatchBuilder in quiet mode in the background. (If the BatchBuilder is run from the command line without this flag, the BatchBuilder screen will be displayed.)
-d or /d Yes Directory field value.
-m or /m Yes Mapping field value.
-n or /n Yes Batch Load File field value.
-e or /e No Exclude specified files (Exclude checkbox selected).
-i or /i No Include specified files (Exclude checkbox deselected).

3.6.2.5.1 Win32 Example

The following example shows the correct syntax to run the BatchBuilder from a Win32 command line, where:

  • Directory = c:/myfiles

  • Mapping File = MyMappingFile

  • Batch Load File = c:/batching/batchinsert.txt

  • Excluded files = *.exe and *.zip

BatchLoader.exe /spider /q /dc:/myfiles /mMyMappingFile /nc:/batching/batchinsert.txt /eexe,zip
3.6.2.5.2 UNIX Example

The following example shows the correct syntax to run the BatchBuilder from a UNIX command line, where:

  • Directory = /myfiles

  • Mapping File = MyMappingFile

  • Batch Load File = /batching/batchinsert.txt

  • Excluded files = index.htm and index.html

BatchLoader -spider -q -d/myfiles -mMyMappingFile -n/batching/batchinsert.txt -eindex.htm,index.html

3.6.3 Running the Batch Loader

This section covers these topics:

3.6.3.1 About Running the Batch Loader

The Batch Loader uses the information from a batch load file to check in (insert), delete, or update a large number of files on your Oracle Content Server system simultaneously.

  • You can run the Batch Loader from the standalone application interface or from the command line.

  • After you run the Batch Loader, the Oracle Content Server instance processes files through the Inbound Refinery and the Indexer as it would for any other content item.

3.6.3.2 Batch Loading from the Batch Loader Screen

Use the following procedure to batch load content using the Batch Loader screen:

  1. Display the Batch Loader Screen.

  2. Click Browse, and navigate to and select the batch load file.

  3. To change the number of errors that can occur before the Batch Loader stops processing, enter the number in the Maximum errors allowed field.

  4. To delete files from the hard drive after they are successfully checked in or updated, select Clean up files after successful check in.

  5. To create a text file containing the file records that failed during batch loading, select Enable error file for failed revision classes.

  6. Click Load Batch File to start the Batch Loader process.

    When the batch load process is complete, a Batch Loader message screen is displayed, indicating the number of errors that occurred, if any.

  7. If you enabled the error file, write down the file name shown in the message box.

  8. Click OK.

  9. Correct any problems with the batch load.

  10. To save the current Batch Loader settings as the default, select Options, Save Configuration.

3.6.3.3 Batch Loading from the Command Line

You can batch load content by entering the Batch Loader parameters from a command line rather than entering them in the Batch Loader screen. Use the following procedure to run the Batch Loader from the command line:

  1. Open the DomainHome/ucm/cs/bin/intradoc.cfg file in a text editor, and add the following line, where sysadmin is the user name of the Oracle Content Server system administrator:

    BatchLoaderUserName=sysadmin
    

    This is required so that the system logs in as the system administrator, because only users who have admin rights have permission to run the Batch Loader application.

  2. Save and close the file.

  3. Open a command line window and change to the DomainHome/ucm/cs/bin/ directory.

    Caution:

    Run the Batch Loader using the same operating system account that runs the Oracle Content Server instance. Otherwise, the software might not process your files due to permissions problems.
  4. Enter the following command:

    Win32: BatchLoader.exe /q /nbatchloadfile
    Unix: BatchLoader -q -nbatchloadfile
    

    The Batch Loader processes the batch load file, but message boxes will not be displayed.

  5. Correct any problems with the batch load.

The following flags can be used with the BatchLoader command from the command line:

Flag Required? Description
-q or /q No Runs the Batch Loader in quiet mode in the background. (If the Batch Loader is run from the command line without this flag, the Batch Loader screen will be displayed.)
-n or /n Yes Batch Load File field value.
-console No Echoes all output to the HTML Oracle Content Server log and to the console window that is running the Batch Loader. For details, see Section 3.6.3.6, "Batch Loader -console Command Line Switch."

3.6.3.3.1 Win32 Example

The following example shows the correct syntax to run the Batch Loader from a Win32 command line, where the batch load file is c:/batching/batchinsert.txt:

BatchLoader.exe /q /nc:/batching/batchinsert.txt
3.6.3.3.2 UNIX Example

The following example shows the correct syntax to run the Batch Loader from a UNIX command line, where the batch load file is /batching/batchinsert.txt:

BatchLoader -q -n/batching/batchinsert.txt

3.6.3.4 Using the IdcCommand Utility and Remote Access

Occasionally, you may need to use remote access when managing your Oracle Content Server instance. This does not necessarily mean that remote terminal access is required. However, you must have the ability to submit commands to the server from a remote location.

Combining remote access with the IdcCommand utility provides a powerful toolset and an easy way to check in a large number of files to your instance. To take advantage of this functionality, you will need to properly set up the workstation to submit commands and be able to use the IdcCommand utility with a batch load command file.

This section covers the following topics:

3.6.3.4.1 Batch Load Command Files

A batch load command file contains a set of commands for each file that is loaded. If you are loading a large number of files, the command file may contain hundreds of lines. Using an editing tool can simplify the task of creating the numerous required lines. For example, the procedure for Preparing for Remote Batch Loading shows how you can prepare a batch load command file using the editing and mail merge features of Microsoft Office.

The following is an example Batch Load Command File:

@Properties LocalData
IdcService=CHECKIN_UNIVERSAL
doFileCopy=1
dDocTitle=thisfile
dDocType=Native
dSecurityGroup=Internal
dDocAuthor=sysadmin
primaryFile=filename
primaryFile:Path=pathtothefile
xComments=Initial Check In
@end
<<EOD>>@Properties LocalData
IdcService=CHECKIN_UNIVERSAL
doFileCopy=1
dDocTitle=99.tif
dDocType=Native
dSecurityGroup=Internal
dDocAuthor=sysadmin
primaryFile=350.afp
primaryFile:path=/lofs/invoices/350.afp
xComments=Initial Check In
@end
<<EOD>>
3.6.3.4.2 Preparing for Remote Batch Loading

To perform batch loading from remote locations, complete the following procedure. The procedure is written for a Microsoft Windows operating system.

To Configure the Local Computer:

  1. Open Windows Explorer.

  2. Create a working directory (for example, c:\working_dir).

  3. In the working directory, create one or more directories for the various Oracle Content Server instances you will be accessing (for example, c:\working_dir\development and c:\working_dir\contribution). These directories can be referred to as DomainHomeName.

  4. In each DonainHomeName directory, create a cmdfiles subdirectory.

  5. From the remote Oracle Content Server instance, copy the following directories from Middleware\user_projects\domains\Domain_Name\ucm\cs into their respective DomainHomeName (in this case C:\working_dir\development and C:\working_dir\contribution).

    • working_dir\DomainHomeName\ucm\cs\bin

    • working_dir\DomainHomeName\ucm\cs\config

  6. From the remote Oracle Content Server instance, copy the following directories (and their files) to your working directory:

    • working_dir\idc\bin

    • working_dir\idc\components

      (copying the CSDms and NativeOsUtils component files should be sufficient)

    • working_dir\idc\config

    • working_dir\idc\jlib

    • working_dir\idc\resources\core\lang

    • working_dir\idc\resources\core\table

    • working_dir\idc\resources\core\config

  7. Using a text editor, open the DomainHomeName\ucm\cs\bin\intradoc.cfg file on your local system and update the IntradocDir configuration variable to match your directory structure. For example:

    IntradocDir=working_dir\DomainHomeName\ucm\cs,
    IdcHomeDir=working_dir\idc
    WeblayoutDir=working_dir\DomainHomeName\ucm\cs\weblayout
    
  8. Using a text editor, open the working_dir\DomainHomeName\ucm\cs\config\config.cfg file on your local system and verify the following settings are correct.

    IntradocServerPort=4444
    IntradocServerHostName=HostMachineName
    
  9. On the remote Oracle Content Server instance, add the IP address of the local computer to the Security Filter, using the SystemsProperties utility.

  10. Restart the remote Oracle Content Server instance.

To Test the Configuration for the Remote Workstation:

  1. In the cmdfiles directory, create a file named pingservertest.hda and add the following lines:

    @Properties LocalData
    IdcService=PING_SERVER
    @end
    

  1. Open a command prompt and change to your working bin directory (for example, cd C:\working_dir\development\bin

  2. Issue the following command:

    IdcCommand -f ..\cmdfiles\pingservertest.hda -u sysadmin -l ..\pingservertest.log -c server
    

  1. Confirm the output. If you are successful, you will get the following message from the server.

    3/24/04: Success executing service PING_SERVER.
    You have completed your setup for remote commands.
    

Create a Batch Load Command File:

This procedure uses the editing and mailmerge features of Microsoft Office to create a batch load command file.

  1. Create a file listing of your directory contents:

    1. Open a command prompt and change to the root directory representing the files you intend to load.

    2. Create a file listing, using the following command to redirect the output into a file:

    3. dir /s /b > filelisting.txt

    4. Check your filelisting.txt file; it will look something like this:

      V:\policies\ADMIN\working_dir_Admin\AbbreviationList.doc
      V:\policies\ADMIN\working_dir_Admin\Abbreviations.doc
      V:\policies\ADMIN\working_dir_Admin\AbsencePres.doc
      V:\policies\ADMIN\working_dir_Admin\AdmPatientCare.doc
      V:\policies\ADMIN\working_dir_Admin\AdmRounds.doc
      V:\policies\ADMIN\working_dir_Admin\AdverseEvents.doc
      V:\policies\ADMIN\working_dir_Admin\ArchivesPermanent.doc
      V:\policies\ADMIN\working_dir_Admin\ArchivesRetrieval.doc
      V:\policies\ADMIN\working_dir_Admin\ArchivesStandardReq.doc
      

      Note:

      When working with batch loads, it is important to note that the file must exist on the server indicated by the primaryFile statement in the batch load command file. Optimally, you should use the same letter to map the directory of files to the server and to your local system. Alternatively, you can copy the directory of files to the server temporarily.
  2. Edit the file listing to create your filename and title data:

    1. Open your filelisting.txt file in Excel.

    2. Using Replace, remove all the directory information leaving only the file name. Also look for and remove the line for filelisting.txt.

    3. Copy column A (containing the file names) to column B. In this example the file name is also used for the title and Column B will become the title.

    4. Using Replace, remove the file extension from the names in column B.

    5. Insert a new first line and enter filename in the first column and title in the second.

    6. Save the file.

  3. Create an hda file from the file listing using Mail Merge features:

    1. Open Word and create a new document with your set of batch load commands. The following example shows basic batch load commands. You must match your configuration settings when you create your batch load commands.

      @Properties LocalData
      IdcService=CHECKIN_UNIVERSAL
      doFileCopy=1
      dDocTitle=
      dDocType=Native
      dSecurityGroup=Internal
      dDocAccount=Policy/Admin
      dDocAuthor=sysadmin
      primaryFile=d:/temp/working_dir_Admin/
      xComments=Initial Check In
      @end
      <<EOD>>
      
  1. Select Tools / Letters and Mailing / Mail Merge Wizard and advance through the wizard. Choose the selections below to use your filelisting.txt file as input to the mail merge.

    • Letter Document (step 1)

    • Current document (step 2)

    • Existing List (step 3) and select your Excel spreadsheet as the data source

    • More Items (step 4), place the title and filename fields into the word document so that it looks like the following:

      @Properties LocalData
      IdcService=CHECKIN_UNIVERSAL
      doFileCopy=1
      dDocTitle="title"
      dDocType=Native
      dSecurityGroup=Internal
      dDocAccount=Policy/Admin
      dDocAuthor=sysadmin
      primaryFile=d:/temp/working_dir_Admin/"filename"
      xHistory=Initial Check In
      @end
      <<EOD>>
      
  2. Complete the mail merge (Steps 5 and 6) and you will have a new Word document with one merge record per page.

  3. Edit the letters, selecting all, and use the Replace feature to remove all of the section breaks.

  4. Save the file as a plain text file to the /cmdfiles directory with the file extension of hda (for example, filelisting.hda)

Execute the Upload:

  1. Open a command prompt.

  2. Navigate to the working bin directory.

  3. Issue the command:

    IdcCommand -f ../cmdfiles/filelisting.hda -u sysadmin -l ../filelisting.log -c server
    

Your files will be checked into the Oracle Content Server repository and a message is displayed in the command window as each file is checked in.

3.6.3.5 Batch Loading Content as Metadata Only

Depending on the action you plan to perform using the Batch Loader, certain fields are required in the batch load file. If you are updating only the metadata in existing content items, the primaryFile field is not required in the batch load file; see Section 3.6.1.5.1, "Update Requirements."

However, if you want to load (insert action) content into the Oracle Content Server instance as metadata only, then the primaryFile field is required in the batch load file. Although the field is ignored by the import, the Batch Loader expects it to be defined. If the primaryFile field is missing, you will get an error as follows (or similar):

Please check record number <number>. BatchLoader: unable to check in '<record>' because the required field 'primaryFile' is missing.

To batch load content as metadata only:

  1. Open the Oracle Content Server instance config.cfg file:

    IntradocDir/config/config.cfg

  2. Add the following configuration variables:

    createPrimaryMetaFile=true
    AllowPrimaryMetaFile=true
    
  3. Save and close the config.cfg file.

  4. In the batch load file, add the following fields for each record:

    primaryFile=
    createPrimaryMetaFile=true
    

    Note that leaving the primaryFile field blank is acceptable. The field is ignored but must be included.

  5. Continue to batch load your content using the Batch Loader procedure or the command line procedure. See Section 3.6.3.2, "Batch Loading from the Batch Loader Screen" or Section 3.6.3.3, "Batch Loading from the Command Line."

3.6.3.6 Batch Loader -console Command Line Switch

Adding the -console switch to the Batch Loader command line causes all output to be echoed to the HTML Oracle Content Server log and to the console window that is running the Batch Loader. Alternatively, you can use operating system redirects to send the output to a separate log file.

Important:

The -console switch does not follow standard Windows command line syntax (although this may be corrected in later versions). You must use the -console syntax usually associated with UNIX instead of the /console syntax. With most other command line utilities, both syntaxes will work on both platforms.
3.6.3.6.1 Win32 Example

Win32 command line:

BatchLoader.exe /q -console /nc:/batching/batchinsert.txt

UNIX command line:

BatchLoader -q -console -n/u2/apps/batching/batchinsert.txt

Sample output:

Processed 1 of 4 record.
Processed 2 of 4 records.
Processed 3 of 4 records.
Processed 4 of 4 records.
Done processing batch file 'c:/batching/batchinsert.txt'. Out of 4 records processed, 4 succeeded and 0 errors occurred.

3.6.3.7 Adding a Redirect

You can use a redirect symbol on the command line to send the Batch Loader output to a separate log file. The symbol works on both UNIX and Windows. By default, the -console switch sends the Batch Loader's output to stderr. To redirect the output to a different file, use the special redirect symbol 2>.

In the following examples, each command must be entered all on one line.

Win32 command line with redirect:

BatchLoader.exe /q -console /nc:/batching/batchinsert.txt 2> batchlog.txt

UNIX command line with redirect:

BatchLoader -q -console -n/u2/apps/batching/batchinsert.txt 2>
/logs/CSbatchload.log

3.6.3.8 Correcting Batch Load Errors

Use the following procedure to correct any errors that occur during batch loading.

  1. Open the Oracle Content Server log. Select Administration, then Log Files, then click Content Server Logs.

  2. Look through the Type column for the word Error.

  3. Read the description to determine the problem.

  4. Fix the error in one of these files:

    • Batch load file

    • The error file for the failed content. (This option is available only if you enabled it on the Batch Loader Screen.) The error file is located in the same directory as the batch load file, with several digits appended to the batch load file name.

      Tip:

      If you rerun an entire batch load file, content items that have already been checked in will usually fail. This occurs because the release dates of the existing content items will be the same as the ones you are trying to insert.

Figure 3-4 Oracle Content Server log file

Description of Figure 3-4 follows
Description of "Figure 3-4 Oracle Content Server log file"

3.6.4 Optimizing Batch Loader Performance

This section provides some basic guidelines that you can use to improve Batch Loader performance. These suggestions can minimize potentially slow batch load performance when you are checking in a large number of content items. In many cases, proper tuning for batch loading can significantly speed up a slow server.

To minimize batch loading slow downs, try implementing the following Batch Loader adjustments:

  • Temporarily disable other activities such as shutting down Inbound Refinery (see the Oracle Fusion Middleware Administrator's Guide for Conversion) and suspending the automatic update cycle feature of the Repository Manager. See Section A.1.3.1, "Repository Manager: Indexer Tab."

  • Analyze your database usage during a batch load to help the database query optimizer. Databases have built-in optimizer utilities that can help make database queries more efficient. However, to maximize the efficiency of optimizers, it is necessary to update or re-create the statistics about the physical characteristics of a table and the associated indexes. These characteristics include number of records, number of pages, and the average record length. The optimizers use these statistics to access data.

    Each database has a proprietary command that you can use to invoke the statistic update or recreation process. For example:

    • For Oracle, use the ANALYZE TABLE COMPUTE STATISTICS command

    • For SQL Server, use the CREATE STATISTICS statement

    • For DB2, use the RUNSTATS command

3.6.4.1 Example: Best Practice Case Study

This case study describes a very slow load batch performance and the steps taken to diagnose and correct the situation. This information can serve as a model for isolating underlying issues and resolving batch loading performance problems.

3.6.4.1.1 Background Information

A user wanted to load 27,000 content items into the Oracle Content Server instance that was running on an AIX server. The DB2 database was running on a separate AIX server. The content items included TIFs as the native files and corresponding PDFs as the Web-viewable files. Inbound Refinery generated thumbnails from the native files.

Initially during the batch load, the performance was acceptable with sub-second insert times. However, after a few thousand content items were loaded, the performance began to degrade. Content items started to require a few seconds to load and, eventually, the load time was over 10 seconds per content item.

3.6.4.1.2 Preliminary Troubleshooting

While the batch load was running, nothing seemed to be wrong with the Oracle Content Server instance. It had sufficient memory, the CPU utilization was low (less than 5%), and there were no disk bottlenecks. The Inbound Refinery server was busy, but was processing thumbnails at an acceptable rate.

Two issues were found with the database server:

  • Two processes were taking turns to update the database. While one process was executing, the second process waited for other process to release database locks. When the first process completed, the second process executed while the first process waited. The processes in this execute/wait cycle included:

    • The actual batch load process that was updating the database tables after inserting a content item.

    • The Oracle Content Server instance was updating the database tables; changing the status from GENWWW to DONE after receiving notification that a thumbnail had been completed.

    The two processes should not have been contending with each other because they were not updating the same content items. It seemed that the two processes were locking each other out because DB2 had performed lock escalation and was now locking entire database pages instead of single rows.

  • There were a large number of tablespace scans being performed by both processes.

3.6.4.1.3 Solution

A two-step solution was used:

  1. Inbound Refinery was shut down to prevent the status update process from competing with the batch loading process. The performance did improve because there was a 2000+ backlog of content items from the completed thumbnails.

  2. A RUNSTATS command was issued on all the Oracle Content Server database tables to update the table statistics. This dramatically improved the performance of the batch load. The insert time returned to sub-second and the batch load completed within a short amount of time. It took 21 hours to insert the first 22,000 content items. After updating the table statistics, the remaining 5,000 content items were inserted in 13 minutes.

3.7 Finding Status and Error Information

Effective troubleshooting relies on the availability of useful, detailed information. The Oracle Content Server products provide various sources of information that can be helpful in the troubleshooting process.

This section covers the following topics:

3.7.1 Log Files

The Oracle Content Server system stores status information and errors in log files. Log files are used to register system events, with their date and time of occurrence. They can be valuable tools for troubleshooting, especially if verbose logging is turned on. Not only do logs indicate that specific events occurred, they also provide important clues about a chain of events that led to an error or problem.

Note:

When applied to process log output, verbose logging can quickly increase the size of a log file and possibly cause the Oracle Content Server instance to slow down. It is recommended that for process logs, verbose logging is only used when troubleshooting a specific issue. Regular Oracle Content Server logs do not have this issue with verbose logging.

Information is also captured in logs controlled by the Oracle WebLogic Server Administration Console using Oracle log APIs. The Oracle UCM interface provides access to these logs. For details, see Section 2.6, "Viewing Log Information for Oracle Content Server."

This section covers the following topics:

3.7.1.1 Log File Characteristics

The log files associated with the Oracle Content Server instance have the following characteristics:

  • They are created only once each day at the time the first status, error, or irrecoverable error occurs.

  • No empty log files are generated.

Each log file contains the following columns:

  • Type: Specifies the kind of incident that prompted the log entry: Information, Error, or Fatal.

  • Time: Lists the date and time the log entry occurred.

  • Description: Describes the incident that occurred.

The log files are standard HTML pages and are maintained for each Oracle Content Server instance. Logs are kept in revolving file name format for a maximum of 30 files. When the 31st file is created, the oldest one is deleted. Therefore, log file names in Oracle Content Server bear no relation to the date they were generated. To find a certain day in the log file, view the index file in a browser and select that day's link. The file name is displayed in the browser's status bar (if it is enabled).

Tip:

Bookmark your log file pages. This will help you to troubleshoot problems, even if the Oracle Content Server instance is unavailable. Also, know where your configuration files are so you can find them if the Oracle Content Server instance is unavailable.

3.7.1.2 Accessing the Log Files

The log files of the Oracle Content Server instance are normally accessed from the Log Files folder in the Administration tray.

Note:

You must be logged into the Oracle Content Server instance as an administrator to be able to view the log files.

If, for whatever reason, you cannot view the log files from the Administration tray, you can also access them on the file system of the Oracle Content Server computer. The log files are located in the following locations:

Log Files Found in:
Oracle Content Server IntradocDir/weblayout/groups/secure/logs
Console Output Logs IntradocDir/bin/classname.log
Refinery IntradocDir/weblayout/groups/secure/logs/refinery
Archiver IntradocDir/weblayout/groups/secure/logs/archiver

3.7.1.3 Using Oracle Content Server Logs

The Oracle Content Server logs 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.

The following types of server log entries are generated:

  • Info: Displays basic status information. For example, status information is logged if the server is ready and waiting.

  • Error: Displays errors that occur but do not stop the software from functioning. For example, an error is logged if a user requests secure information that they are not allowed to access.

  • Fatal: Displays errors that stop the software from functioning. For example, a fatal error is logged if the Oracle Content Server instance cannot access the database.

To open an Oracle Content Server log:

To open a server log, complete the following steps:

  1. Ensure that you are logged into Oracle Content Server as an administrator.

  2. Click Content Server Logs on the Administration page or in the Administration tray's Log Files folder.

    The Content Server Logs Screen is displayed.

  3. Select the link that corresponds to the date and the time of the log that you want to view.

3.7.1.4 Using Archiver Logs

Archiver logs show information about imports, exports, and replications. The Archiver logs are listed by date and time. They are generated once a day when the first Archiver information status, fatal error, or error occurs.

The following types of archiver log entries are generated:

  • Info: Displays basic status information. For example, status information is logged when an export and an import starts and finishes.

  • Error: Displays user/administration errors that occur but do not stop the software from functioning. For example, an error is logged if there is no file information for a content item that you are trying to export.

  • Fatal: Displays errors that stop the software from functioning. For example, a fatal error is logged if the Oracle Content Server instance cannot access the database. Check the connection string, user name, and password.

To open an Archiver log:

To open an Archiver log, complete the following steps:

  1. Ensure that you are logged into Oracle Content Server as an administrator.

  2. Click the Archiver Logs link, found on the Administration page or in the Administration tray's Log Files folder.

    The Archiver Log Screen is displayed.

  3. Select the link that corresponds to the date and the time of the log.

    A table showing the type, date and time, and description of each action is displayed. It also includes the name of the Oracle Content Server instance that created the archive.

3.7.1.5 Inbound Refinery Logs

With the release of Inbound Refinery version 11gR2, all Refinery logging is accessed through the Inbound Refinery interface. For more information see the Oracle Fusion Middleware Administrator's Guide for Conversion.

3.7.2 Configuration Information

The Oracle Content Server system provides a Configuration Information Page that displays configuration information for a Oracle Content Server instance, which may be useful while troubleshooting a problem or working with the Oracle support organization. To access this page, select Administration in the portal navigation bar, then select Configuration for Instance. To display more details, click the link for each type of configuration information.

Configuration information is provided for:

  • Server name

  • Version

  • Class loader

  • Instance directory

  • Database type

  • Database version

  • HTTP server address

  • Mail server

  • Search engine name

  • Index engine name

  • Number of installed features

  • Number of enabled components

  • Number of disabled components

  • Auto number prefix

  • Use accounts

  • Ntlm security enabled

  • Allow get copy for user with read privilege

  • Allow only original contribute to check out

  • Java version

Note:

Some options are specified during the software installation, while others are set using the System Properties utility.

3.7.3 System Audit Information

The Oracle Content Server system provides a System Audit Information Page for the Oracle Content Server instance, which may be useful while troubleshooting a problem or adjusting a server's performance. To access this page, select Administration in the portal navigation bar, then select System Audit Information.

The System Audit Information page provides several types of information:

3.7.3.1 System Audit General Information

The General Information section of the System Audit Information Page provides the following:

  • Information regarding whether the system is receiving too many requests. If it is receiving too many requests, an e-mail is sent to the system administrator regarding load performance.

  • Information about the memory cache for the system, and is useful in troubleshooting any "out of memory" errors you may receive. This is important when running the Oracle Content Server instance with many users and a large quantity of data.

  • Information about which Java threads are currently running. This is useful in determining the cause of an error.

  • Information about database activity.

  • Listing of any audit messages.

To display more information, click the link on the page for the type of configuration information.

3.7.3.2 System Audit Localization Information

The Localization Information section of the System Audit Information Page provides information on:

  • String key count

  • Whether the Localization system is using a string index

  • Localization test run time

  • Localization test lookups per second

3.7.3.3 System Audit Tracing Sections Information

The Tracing Sections Information section of the System Audit Information Page enables tracing in the Oracle Content Server instance, which can be activated on a section-by-section basis. Tracing for active sections is displayed on the Server Output Page. Section tracing is useful for determining which section of the server is causing trouble, or when you want to view the details of specific sections.

Sections can be added for tracing by appending extra sections to create a comma separated list in the Active Sections field. A listing of the sections available for tracing, with brief descriptions, is available by clicking the Info icon next to the Tracing Sections Information heading. The wildcard character * is supported so that using schema* will trace all sections that begin with the prefix schema.

Some tracing sections also support verbose output. Enable Full Verbose Tracing if you want to see in-depth tracing for any active section that supports it. For more information, see Section 3.7.5, "Tracing."

Important:

Any options set in Tracing Sections Information will be lost when the Oracle Content Server instance is restarted unless you enable Save and click Update.

3.7.3.4 System Audit Cache Information

The Oracle Content Server instance caches various items for quick access. The Cache Information section of the System Audit Information Page displays current information of three main caches:

  • Search cache: Information about the number of searches currently being run, how many executed searches are currently in cache, and when the cache is emptied. These details are useful when troubleshooting any search related issues.

  • Schema cache: Details of any schema items currently in cache.

  • Buffer: Information about Java objects in cache and how much memory each object is using, which is reflected in the memory information under the System Audit General Information section. This information can be useful in pinpointing which object may be responsible for any memory leaks or other memory issues.

To display more information, click the link for the type of cache information on the page.

3.7.3.5 System Audit Configuration Entry Information

The Configuration Entry Information section of the System Audit Information Page provides information on:

  • Number of environment keys

  • Number of overwritten config values

  • Number of ignored settings

  • Number of removed settings

To display more information, click the link for the type of configuration entry information on the page.

3.7.3.6 System Audit Component Report Information

The Component Report Information section of the System Audit Information Page provides the following information for components on the Oracle Content Server instance:

  • Location: pathname for the component in the instance

  • Version: date, build, and revision

  • Status: current status of the component (Loaded or Skipped)

  • Reason: an explanation of the component status

To display details about a component, click the link for the component name on the page.

3.7.3.7 Server Output Page

The Server Output page displays the console output of the Oracle Content Server instance. This is the same information that is located in the DomainHome/ucm/cs/bin/classname.log file. It includes information pertaining to all the sections selected for audit tracing in the System Audit Tracing Sections Information. To access the Server Output page, click View Server Output on the System Audit Information page.

3.7.4 Monitoring Scheduled Jobs

Scheduled jobs run as part of events scheduled by system components. The Scheduled Jobs Administration Interface can be used to monitor information about scheduled jobs on the Oracle Content Server instance.

3.7.4.1 Viewing Active Scheduled Jobs

  1. Select Administration from the portal navigation bar.

  2. Select Scheduled Jobs Administration.

  3. Select Active Scheduled Jobs.

    The job name, job description, processed date and time, current status, and available actions are listed for each scheduled job on the Active Scheduled Jobs Screen.

  4. Click Actions to select any of the following actions for a scheduled job:

  5. Click Info to display the Scheduled Jobs Information Screen.

3.7.4.2 Viewing Scheduled Jobs History

  1. Select Administration from the portal navigation bar.

  2. Select Scheduled Jobs Administration.

  3. Select Scheduled Jobs History.

    The job name, description, last process date, process status, and actions are listed for each scheduled job on the Scheduled Jobs History Screen.

3.7.4.3 Viewing Scheduled Jobs Information

  1. Select Administration from the portal navigation bar.

  2. Select Scheduled Jobs Administration.

  3. Select either Active Scheduled Jobs or Scheduled Jobs History, then click Info for a specific job to view information.

    The job name, description, category, exception parent job, initial user, queue type, schedule type, current state, priority, interval, start token, progress status, create date, update date, process date, last processed date, and last processed status are displayed.

  4. To display a Scheduled Jobs Information Screen that can be edited, select Edit from the Actions menu on the Active Scheduled Jobs Screen.

3.7.5 Tracing

You can activate Oracle Content Server tracing to display detailed system information that may be very useful for troubleshooting and optimizing system performance.

3.7.5.1 Server-Wide Tracing

Server-wide tracing is used to view activities throughout the system. There are two ways to activate server-wide tracing.

To activate tracing from the Administration interface:

  1. Select Administration from the portal navigation bar.

  2. Select System Audit Information.

  3. Enable Full Verbose Tracing to see in-depth tracing for any active section that supports it.

  4. Specify the traces to activate.

  5. Click Update.

  6. Click View Server Output.

    Tip:

    Tracing options are lost on system restart. To ensure your settings are retained after restarting the Oracle Content Server instance, enable Save before clicking Update.

To activate tracing from an applet:

  1. Start an administrative applet.

  2. Select Options and then Tracing.

  3. Select Server tracing.

  4. Select the tracings to activate or all and click OK.

The following tracing options are available. Additional tracing sections can be displayed in the list if components are added.

  • applet: This trace contains result sets from initialized applets, such as the Configuration Manager or User Admin.

  • archiver: This trace provides information about archiving activities, including the reading and writing of archiver data files and the time the activities were initiated and finished.

  • archiverlocks: This trace provides information about the locks put on files during archiving activities, including time initiated.

  • chunkedrequest: This trace displays the messages and headers that are created when large requests are 'chunked' into smaller requests.

  • docprofile: This trace displays the computation of content profiles, specifically the evaluation of the rules that determine which fields are labels, hidden, and so on.

  • encoding: This trace provides information about encoding transformations that have occurred and the activities where encoding occurred.

  • filelock: This trace displays information about short-term system locks put on directories (during activities like archiving, for example) with a focus on collisions that occur and time outs.

  • filelonglock: This trace displays information about the creation, removal, and maintenance of long term locks imposed by the system.

  • filequeue: This trace displays information about accesses to a file queue.

  • indexer: This trace displays information about index functions that occur when the database is updated, including the steps taken to update the index and the time elapsed for each step.

  • indexermonitor: This trace provides a brief summary of automatic index activities, including time started and ended.

  • indexerprocess: This trace displays information about a manually launched index process and indicates if the process terminated properly.

  • localization: This trace displays information about localization usage and activities.

  • mail: This trace describes mail sent by the Oracle Content Server instance.

  • pagecreation: This trace displays information about the creation of displayed pages, including the server thread and the time taken to generate the page.

  • requestaudit: This trace provides summary reports on service requests, including the elapsed time for the requests and the number of requests made.

  • scheduledevents: This trace provides a list of hourly or daily background scheduled events.

  • schema: This trace provides information about schema publishing (tables and views published as .js files) and caching (tables cached into Oracle Content Server memory).

  • searchquery: This trace displays information about recent searches, including the fields used to search on and the order of sorting for results.

  • socketrequests: This trace displays the date, time, and thread number of socket requests and the actions during the request.

  • system: This trace displays internal system messages, such as system socket requests and responses.

  • systemdatabase: This trace provides information about database activities, including queries executed, index updates, threads used, and time initiated.

  • transfermonitor: This trace displays information about the archiver and the batch file transfer activities.

  • userstorage: This trace describes the access of external user repositories, including what actions were taken during access.

  • workflow: This trace displays a list of metadata on content items going through workflow, including document title and revision number.

    Note:

    To facilitate international support, most tracing messages are in English and do not have translations.

3.7.5.2 Applet-Specific Tracing

For applet-specific tracing, the output goes to the browser Java console. To perform tracing by applet:

  1. Start the administration applet to be traced.

  2. Select Options, then select Tracing.

  3. Make your selections, and click OK. The output is directed to the browser Java console.

Figure 3-5 Applet-specific Tracing

Description of Figure 3-5 follows
Description of "Figure 3-5 Applet-specific Tracing"

3.7.6 Environment Packager

The Environment Packager is a diagnostic tool. It creates a zip file of the desired state directories, log files, and other component and resource directories.

To create an environment zip file, complete the following steps:

  1. Ensure that you are logged in to Oracle Content Server as an administrator.

  2. From the Administration tray, click the Environment Packager link. The Environment Packager Page is displayed.

  1. Select which parts of the environment should be packaged.

  2. When you are ready to create the environment zip file, click Start Packaging.

    A message is displayed while the zip file is being built, with a link to the zip file. The packaging process may take several minutes. The zip file link will not be available until the process has finished.

    Note:

    The packaged zip is named server_environment_*.zip. While the Oracle Content Server instance builds the packaged zip file, it will be located in IntradocDir/vault/~temp. When the build of the zip file is complete, it is moved to IntradocDir/weblayout/groups/secure/logs/env.

3.7.7 Content Server Analyzer

The Content Server Analyzer application enables you to confirm the integrity of the Oracle 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.

Using the Content Server Analyzer, system administrators can do the following:

  • Confirm the accuracy of synchronization between three important Oracle Content Server database tables (Revisions, Documents, and DocMeta).

  • Confirm that the dRevClassID and dDocName fields are consistent across all revisions of content items.

  • Determine if the file system (native and Web-viewable file repositories) contains any duplicate or missing files.

  • Ensure the accuracy of synchronization between the search index and the file system.

  • Ensure the accuracy of synchronization between the search index and the Revisions database table.

  • Ensure that the file system contains all necessary files.

  • Remove duplicate files from the Oracle Content Server repository either permanently or provisionally by moving them into the logs/directory.

  • Produce a general report on the state of content items in the Oracle Content Server repository.

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

  • Windows: Select Start, then Oracle Content Server, then Instance_Name, then Content Server Analyzer.

  • UNIX: Navigate to the DomainHome/ucm/cs/bin directory and run the Oracle Content Server Analyzer program.

These sections describe Oracle Content Server Analyzer tasks:

3.7.7.1 Accessing the Content Server Analyzer

To display the Content Server Analyzer, use one of the following methods:

  • Windows: Select Start, then Programs, then Content Server, then instance_name, then Utilities and then Content Server Analyzer.

  • UNIX: Change to the DomainHome/ucm/cs/bin directory, type IdcAnalyze in a shell window, and press the RETURN key.

The Content Server Analyzer application is displayed.

3.7.7.2 Specifying a Custom Analyzer Log Directory

The logs/ directory is the default logging directory for the Content Server Analyzer. Analysis output files are written to this directory and extra files detected during a file system analysis process can be transferred here as well. Optionally, the default logs/ directory name and path can be changed as desired.

To customize the Analyzer log directory name and path:

  1. On the Content Server Analyzer: Configuration Tab, place the cursor in the Analyzer log dir field.

  2. Enter the desired directory path.

    During the next analysis process, the Content Server Analyzer automatically creates the specified directory or directories in the DomainHome/ucm/cs/bin/ directory hierarchy.

3.7.7.3 Invoking the Analysis Process

To invoke the analysis process:

  1. On the Content Server Analyzer: Configuration Tab, select and activate the desired options (checking the corresponding checkboxes).

  2. Click Start Analysis.

    Note:

    If this is the very first time the Content Server Analyzer has been run, the output files in the logs/ directory are automatically created. On subsequent analysis processes, a confirmation message is displayed asking to overwrite the existing log file.
  3. Click Yes to overwrite the existing log file.

    The Content Server Analyzer: Progress Tab is displayed automatically.

    Note:

    If you click No, the analysis process is terminated and you are prompted to manually remove files from the logs/ directory before running the Content Server Analyzer again.

    A completion message is displayed when all of the selected analysis processes are finalized.

  4. Click OK.

    The results are displayed in the console area on the Progress tab.

3.7.7.4 Analyzing the Oracle Content Server Database

The Check RevClassIDs and Clean database options are used to check the integrity of the database columns. The available options enable users to examine the three tables that are used to store content item revision information (DocMeta, Documents, and Revisions). The DocMeta file is examined for extra entries that are not found in the Revisions table. Similarly, the Documents table is examined to verify that there are sufficient entries to correspond to the entries in the Revisions table.

Shows options for analyzing the database

Note:

The Check RevClassIDs and Clean database options are activated and selectable only when the Check database option is selected.

To analyze the Content Server database:

  1. On the Content Server Analyzer: Configuration Tab, select the applicable options.

  2. Click Start Analysis.

    The results are displayed in the console area on the Content Server Analyzer: Progress Tab. For information about the analysis procedure, see Section 3.7.7.3, "Invoking the Analysis Process."

3.7.7.5 Analyzing the Oracle Content Server Search Index

The Check search index and csIDCAnalyzeCleanIndex options are used to check the entries in the Revisions table to ensure that all of the documents that belong in the index are properly listed. Additionally, a check can be performed to ensure that there are no duplicate entries in the search index.

Shows options for analyzing the search index

Note:

The csIDCAnalyzeCleanIndex option is activated and selectable only when the Check search index option is selected.

To analyze the Oracle Content Server search index:

  1. On the Content Server Analyzer: Configuration Tab, select the applicable options.

  2. Click the Start Analysis button (for information about the analysis procedure, see Section 3.7.7.3, "Invoking the Analysis Process."

    The results are displayed in the console area on the Content Server Analyzer: Progress Tab.

3.7.7.6 Analyzing the Oracle Content Server File System

The Check file system, Delete, Safe delete, and Check for extra files options are used to check the integrity of the file system (weblayout and vault file repositories). Using the information in the database, these options ensure that every file in the Revisions table contains accurate entries corresponding to the items in the file system. A check can also be completed to locate any extra files in the vault and weblayout file repositories.

Options for checking integrity of the file system

Note:

The Delete, Safe delete, and Check for extra files options are activated and selectable only when the Check file system option is selected.

To analyze the Oracle Content Server file system (vault and weblayout file repositories):

  1. On the Content Server Analyzer: Configuration Tab, select the applicable options.

  2. Click Start Analysis.

    The results are displayed in the console area on the Content Server Analyzer: Progress Tab. For information about the analysis procedure, see Section 3.7.7.3, "Invoking the Analysis Process."

3.7.7.7 Viewing the Analysis Progress and Results

The Content Server Analyzer: Progress Tab is displayed automatically when the Start Analysis button is clicked. The progress bars show when the Content Server Analyzer has completed processing the selected analysis options. The following image shows a partially finished analysis:

When the analysis process is complete, the results are displayed in the console area of the Progress tab. The results depend on what analysis options were selected. The following image of the console area shows the results from selecting database, search index, and file system options:

Note:

The Generate report option was not selected for this example. For an example of the generated status report, see Section 3.7.7.8, "Generating a Status Report."

Figure 3-6 Example Console Display of Results

Description of Figure 3-6 follows
Description of "Figure 3-6 Example Console Display of Results"

3.7.7.8 Generating a Status Report

The status report generated by the Content Server Analyzer provides statistics about the content items in the repository. The status report output is displayed in the console area of the Progress tab.

To generate a status report:

  1. On the Content Server Analyzer: Configuration Tab, select Generate report.

  2. Click Start Analysis.

    When the analysis process is complete, the status report information is displayed immediately following the standard analysis results in the console area of the Content Server Analyzer: Progress Tab.

3.7.7.9 Canceling the Status Report

The report generation feature can be suppressed after the analysis process has already started. To cancel the content item status report during the analysis process:

  1. During the analysis process, click Cancel on the Content Server Analyzer Application.

    You are prompted about canceling after the current task is finished.

  2. Click Yes to suppress the status report.

    The status report is not included with the analysis results that are displayed in the console area of the Progress tab.

3.7.8 Configuration Debug Entry

The Oracle Content Server system also provides a debugging configuration variable that, when set, contributes applicable diagnostic information. The configuration variable is named IsDevelopmentEnvironment, and it is set in the Oracle Content Server instance's configuration file (IntradocDir/config/config.cfg) during installation and when the Oracle Content Server instance is updated. This entry does the following:

  • Defines whether the Oracle Content Server instance should run in debug mode.

  • Enables a trace of script errors. If used as a parameter to a service call, script error information can be added to the bottom of the displayed page.

Another debug configuration variable is named AlwaysReportErrorPageStackTrace. When this variable is set, whenever an error occurs the stack trace is reported on the browser showing the Oracle Content Server user interface.

Note:

For further details refer to the Oracle Fusion Middleware Idoc Script Reference Guide.

3.7.9 Stack Traces

The stack trace enables you to see what threads are currently running in the Oracle Content Server instance. It is a useful troubleshooting tool that provides information about the threads and enables you to monitor Oracle Content Server processing.

For instructions to initiate a current stack trace for the Oracle Content Server instance, see Oracle WebLogic Server documentation.