3 Managing System Processes

This chapter describes how to start and stop an Oracle Content Server or Inbound Refinery instance, how to start Content Server administration applications, and how to use a command-line tool to configure system variables.

This chapter includes the following topics:

Starting and Stopping Content Server and Inbound Refinery

There are several methods for starting, stopping, and restarting the 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 the Content Server instance, such as when components are enabled or disabled, the instance must be restarted.

For the Inbound Refinery (IBR) instance, the only method available is to use Oracle Enterprise Manager Fusion Middleware Control.

Available methods for managing the Content Server instance include:

Note:

In earlier releases, the Content Server's Admin Server could be used to start, stop, and restart the Content Server instance. This functionality has been replaced as of 11g Release 1 (11.1.1).

Starting and Stopping Content Server and Inbound Refinery Using Fusion Middleware Control

Oracle Enterprise Manager Fusion Middleware Control is used by administrators to manage an Oracle WebLogic Server running a WebCenter Content domain with the Content Server or Inbound Refinery instance.

The Content Server and Inbound Refinery instances are initially started during the process of installing and deploying the instance on a managed server on an Oracle WebLogic Server domain. The Content Server and Inbound Refinery instances can be stopped and restarted for several reasons, including changing the configuration, such as enabling or disabling a component.

See Starting and Stopping Oracle WebLogic Server Instances in Administering Oracle Fusion Middleware.

Starting Content Server or Inbound Refinery Using Fusion Middleware Control

To start the Content Server or Inbound Refinery (IBR) instance:

  1. Log in to Fusion Middleware Control.
  2. In the navigation tree, expand the appropriate domain name (for example, Farm_base_domain), then WebCenter, then Content.
    • For the Content Server instance, expand Content Server, then select the Content Server instance name (for example, Oracle WebCenter Content - Content Server (UCM_server1)).

    • For the Inbound Refinery instance, expand Oracle Inbound Refinery, then select the Inbound Refinery instance name (for example, IBR (IBR_server1)).

  3. On the instance home page, from the Content Server or IBR menu choose Control, then Start.

Stopping Content Server or Inbound Refinery Using Fusion Middleware Control

To stop the Content Server or Inbound Refinery (IBR) instance:

  1. Log in to Fusion Middleware Control.
  2. In the navigation tree, expand the appropriate domain name (for example, Farm_base_domain), then WebCenter, then Content.
    • For the Content Server instance, expand Content Server, then select the Content Server instance name (for example, Oracle WebCenter Content - Content Server (UCM_server1)).

    • For the Inbound Refinery instance, expand Oracle Inbound Refinery, then select the Inbound Refinery instance name (for example, IBR (IBR_server1)).

  3. On the instance home page, from the Content Server or IBR menu choose Control, then Shut Down....

Restarting Content Server or Inbound Refinery Using Fusion Middleware Control

To restart the Content Server or Inbound Refinery (IBR) instance:

  1. Log in to Fusion Middleware Control.
  2. In the navigation tree, expand the appropriate domain name (for example, Farm_base_domain), then WebCenter, then Content.
    • For the Content Server instance, expand Content Server, then select the Content Server instance name (for example, Oracle WebCenter Content - Content Server (UCM_server1)).

    • For the Inbound Refinery instance, expand Oracle Inbound Refinery, then select the Inbound Refinery instance name (for example, IBR (IBR_server1)).

  3. On the instance home page, from the Content Server or IBR menu choose Control, then Shut Down....
  4. Confirm that the instance is shut down.
  5. From the Content Server or IBR menu choose Control, then Start.

Starting and Stopping Content Server Using WebLogic Server

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

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

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

See Starting and Stopping Oracle WebLogic Server Instances in Administering Oracle Fusion Middleware.

Starting Content Server Using WebLogic Server Administration Console

To start the Content Server instance:

  1. On the Administration Console home page, in the Domain Configurations area, choose Environment, then Servers.
  2. On the Configuration tab for the Summary of Servers page, select the name of the WebCenter Content server for the Content Server instance.
  3. In the Settings for server_name section, click the Control tab.
  4. On the Start/Stop tab, in the Server Status area, select the server name (for example, UCM_server1), then click Start.

Stopping Content Server Using WebLogic Server Administration Console

To stop the Content Server instance:

  1. On the Administration Console home page, in the Domain Configurations area, choose Environment, then Servers.
  2. On the Configuration tab for the Summary of Servers page, select the name of the WebCenter Content server for the Content Server instance.
  3. In the Settings for server_name section, click the Control tab.
  4. On the Start/Stop tab, in the Server Status area, select the server name (for example, UCM_server1), then click Shutdown.

Restarting Content Server Using WebLogic Server Administration Console

To restart the Content Server instance:

  1. On the Administration Console home page, in the Domain Configurations area, choose Environment, then Servers.
  2. On the Configuration tab for the Summary of Servers section, select the name of the WebCenter Content server for the Content Server instance.
  3. In the Settings for server_name section, click the Control tab.
  4. On the Start/Stop tab, in the Server Status area, select the server name (for example, UCM_server1), then click Shutdown.
  5. Confirm that the Content Server instance has stopped, then click Start (or Resume).

Starting and Stopping Content Server Using 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 script examples assume that the Content Server instance has been previously started as part of the software installation process. See Installing and Configuring Oracle WebCenter Content.

Caution:

These script commands control the Oracle WebLogic Server, which includes the WebCenter Content and WebLogic Administration Servers. The Administration Server includes the Administration Console. If you do not want to start or stop the Oracle WebLogic Administration Server, then use another method to start the Content Server instance.

Starting Content Server Using Scripts

To start the Content Server instance:

  1. Run the appropriate type of script to start the Oracle WebLogic Server Administration Console.
  2. Run the appropriate type of script to start the Oracle WebLogic Server Managed Server with the WebCenter Content server with the Content Server instance. In the following script examples, the instance is 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

Stopping Content Server Using Scripts

To stop the Content Server instance:

  1. Run the appropriate script to stop the WebCenter Content server with the Content Server instance on the Oracle WebLogic Server Managed Server. In the following script examples the instance is named UCM_server1.
  2. 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

Restarting Content Server Using Scripts

To restart the Content Server instance:

  1. Run the appropriate script to stop the Oracle WebLogic Server Managed Server with WebCenter Content and the Content Server instance. In the following script examples the instance is named UCM_server1.
  2. Next, only if necessary, run the script to stop the Oracle WebLogic Server Administration Server.
  3. When the server or servers have stopped, if appropriate run the script to start the Oracle WebLogic Server Administration Server.
  4. Run the script to start the Oracle WebLogic Server Managed Server with WebCenter Content and the Content Server instance.

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

Running 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 and that the Content Server administrator be a local user.

Running Administration Applications as Applets

You can run several of the Content Server administration applications as applets from any web browser with access to the 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 Content Server instance is deployed. 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 Content Server instance as an administrator.
  3. Choose Administration, then Admin Applets.
  4. Choose an administration application from the list of applets.

Running Administration Applications via the Oracle WebCenter Content Administration App

You can run these Content Server administration applications using the desktop admin app: Archiver, Configuration Manager, Content Categorizer Administration, Data Engine Control Center, PDF Watermark Administration, Repository Manager, User Admin, Web Layout Editor, and Workflow Admin. You can also run the admin app in a browser via the native user interface.

The Batch Loader, Component Wizard, System Properties, and Content Server Analyzer utilities cannot be accessed via the desktop app for security reasons. They must be run in the standalone mode from the computer where the Content Server instance is installed. See Running Administration Applications in Standalone Mode.

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

Before You Begin
  • The desktop admin app is supported only for 12.2.1.4.0 and higher releases.
  • The desktop admin app supports the corporate single sign on (SSO).
  • In the scenarios where the Content Server is front-ended by a load balancer or Oracle HTTP Server, the desktop admin app uses the URL of either of these to access the Content Server.
  • The desktop admin app is designed to run on Windows, Mac, and Linux. See the certification matrix for information on the supported versions of these operating systems.
  • If you have not already installed the admin app, you can do so now. Installers for Windows, Mac, and Linux are available for download via Content Server Home > Administration > Admin Applets. The URL should look like this: http://example.com:16200/cs/idcplg?IdcService=GET_ADMIN_PAGE&Action=GetTemplatePage&Page=ADMIN_APPLETS

    Note:

    After the installation is successfully completed, a desktop icon is created for you.
    The desktop admin app is installed at the following locations:
    • Windows: C:\Program Files\Oracle WebCenter Content Administration. If the c:\ drive is not available, the installer automatically detects the program files folder, and the app is installed in that folder. To set proxy, if you use a server URL and port instead of a pac script, ensure that the URL is configured in the Internet Explorer options.
    • Mac: /Applications/Oracle WebCenter Content AdministrationOn Mac, the proxy should be configured in Safari > Preferences.
    • Linux: Where .tar is extracted. On Unix, you can set the proxy server in the terminal before launching the script: export http_proxy=http://my.proxyserver.net:8080/
  • Once you've downloaded the .tar file for Linux, untar it. Instructions to install the admin app on Linux are available in the README file located in the wccadmin folder.
  • When a new version of the admin app is available, the following message is displayed on your screen when you try to launch an older version of the app:

    This version of the Administration client is too old to connect to the Content Server. Please install the Administration client associated with the Content Server.

On Windows and Mac, you can launch the app from the browser via the CS Admin Applets page by clicking Launch Client. To use the desktop admin app in a browser, you must first specify the Http server address in the config.cfg of the Content Server, if it's not already specified.

To run an administration application using the desktop app:

  1. Double-click the desktop icon that is created after you install the app.

  2. In the Oracle WebCenter Content - Administration dialog, log in to the Content Server instance as an administrator or subadministrator:

    1. In the User Name field, enter the user name that has access rights.
    2. In the Password field, enter the password.
    3. In the Server field, enter the server address of your Content Server instance in this format: https://host.example.com:16200/cs/

      If the Content Server version is compatible with the desktop admin app, then the app connects to the server and the last connected server URL is saved in this field. You can select the this URL from this drop-down list for subsequent logins. In case you try to connect to incompatible versions, an error message is displayed.

    4. Click OK.

      The WebCenter Administration app is displayed. This app lets you configure and manage the following applications: Archiver, Configuration Manager, Content Categorizer Administration, Data Engine Control Center, PDF Watermark Administration, Repository Manager, User Admin, Web Layout Editor, and Workflow Admin.

      Note:

      The application are listed based on the users privileges and the components that are enabled in the Content Server.

  3. In the WebCenter Administration app, click the application you want to configure or whose configurations you want to edit to display its configuration page.

Running Administration Applications in Standalone Mode

You can run Content Server administration Java applications in standalone mode from the computer where a 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 utilities can be run only in standalone mode, such as System Properties and Batch Loader. The method required to start these programs differs slightly between Windows and UNIX installations.

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.

Standalone administration applications require that the Content Server system administrator running the applications be a local admin user, instead of a user defined through Oracle WebLogic Server. (Local users are otherwise unused in Oracle WebLogic Server.) To use standalone administration applications that require a login, run the User Admin applet and define a new local user with Admin permissions in Content Server. For information on local users, see Local Users. For details on using the User Admin applet to create a local user, see Editing a User Login.

Note:

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

If a standalone application is required to connect to a 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. See Configuring the WebCenter Content Domain in Installing and Configuring Oracle WebCenter Content.

Running a Standalone Application on a UNIX System

To run a 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:
    % ./intradocApp workflow
    
  3. Click Enter. For all applications except for the Component Wizard and the System Properties utility, a login window opens. For the Component Wizard and the System Properties utility, the main window of the application opens.
  4. Enter the administrator login name and password.
  5. Click OK.
Running a Standalone Application on a Windows System

To run a Content Server administration application in standalone mode on a Windows operating system.

  1. Select the application or utility from the Windows Start menu:
    • To run an administration application, from the Start menu choose Programs, then Content Server, then instance, then application.

    • To run an administration utility, from the Start menu choose Programs, then Content Server, then Utilities, then utility.

    For all applications except for the Component Wizard and the System Properties utility, a login window opens. For the Component Wizard and System Properties utility, the main window of the application opens.

    Tip:

    It may take several seconds for the login window or the application window to appear, or the window may be hidden by other windows.

  2. Enter the administrator login name and password.
  3. Click OK.

    The main window of the application opens.

Configuring a System Database Provider for Standalone Mode

Content Server administration applications and utilities that can only run in standalone mode require specific configuration to run in an Oracle WebLogic Server domain with Oracle WebCenter Content and the 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.

Follow these steps to configure connections for standalone mode:

  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.
  3. In the Paths tab of the System Properties window, the Specify Database Driver Classpath check box 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. In 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 Content Server instance, run ./BatchLoader.
Configuring a JDBC Database Driver for Standalone Mode

For Content Server to work with administration applications that only run in standalone mode (for example, Batch Loader, System Properties, and Content Server Analyzer utilities) you must configure a JDBC driver for the system database or an external database provider. Oracle Fusion Middleware DataDirect JDBC drivers for Microsoft SQL Server and IBM DB2 databases are available to support Content Server standalone applications. You can use the System Properties utility to enter the configuration information.

To configure a JDBC Driver for standalone applications:

  1. As a WebCenter Content system administrator, run SystemProperties from the bin/ directory for the Content Server instance to start the System Properties utility:
    • UNIX path: DomainHome/ucm/cs/bin/SystemProperties

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

  2. On the System Properties screen, click the Database tab, then 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, then Connection Pool. In 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. In 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 Content Server instance.
Configuring an External Database Provider for Standalone Mode

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

For standalone applications to use the OracleTextSearch feature as an external search engine, 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.

Using the IdcShell Command-Line Tool to Run Idoc Script

The IdcShell tool enables administrators to run Idoc Script from a command line. Idoc Script is a proprietary server-side custom scripting language for the WebCenter Content system. This scripting language enables administrators to reference variables, conditionally include content in HTML pages, and loop over results returned from queries.

Idoc Script is used primarily for configuration settings and the presentation of HTML templates. Idoc variables (sometimes called configuration variables or environment variables) can be used in Idoc Script and in configuration files. See Configuration Variables in Configuration Reference for Oracle WebCenter Content. See Introduction to the Idoc Script Custom Scripting Language in Developing with Oracle WebCenter Content.

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 Content Server or Inbound Refinery instances.

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

bin/IdcShell "include shell_help"

Table 3-1 lists and describes Idoc Script functions typically used with the IdcShell command-line tool.

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 lists and describes dynamichtml definitions typically used with the IdcShell command-line tool.

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.