12 Extending the Domain to Include Inbound Refinery

This chapter describes how to extend a domain with Oracle WebCenter Content: Inbound Refinery using the Oracle Fusion Middleware Configuration Wizard. It contains the following sections:

Note:

Before starting the setup process, read the release notes for additional installation and deployment information. They are available on the Oracle Fusion Middleware Documentation Library at http://docs.oracle.com/cd/E23943_01/relnotes.htm.

12.1 Overview of Extending the Domain for Oracle WebCenter Content: Inbound Refinery

Oracle WebCenter Content: Inbound Refinery is required for document conversion by Oracle WebCenter Content Server. The actual number of Inbound Refinery managed servers varies depending on requirements. For availability reasons, Oracle recommends configuring at least two Inbound Refinery managed servers. Configure these servers on separate machines. In the reference Oracle WebCenter Content enterprise deployment topology, Inbound Refinery will be configured on the same machine as Content Server.

Even though a cluster is created in the process of extending the domain with Inbound Refinery, each Inbound Refinery instance is completely independent. Clustering is used for management purposes only.

Extend the domain to include Oracle WebCenter Content: Inbound Refinery. Table 12-1 lists the steps for configuring WebCenter Content and other tasks required for extending the domain with Inbound Refinery managed servers.

Table 12-1 Steps for Extending the Domain with Inbound Refinery

Step Description More Information

Prepare for extending the domain for Inbound Refinery

Associating WLS_IBR1 and WLS_IBR2 with virtual host names.

Section 12.2, "Associating Inbound Refinery Managed Servers with Virtual Host Names"

Extend the domain for Inbound Refinery

Extend the WebLogic domain you created in Chapter 8, "Creating a Domain for an Enterprise Deployment."

Section 12.3, "Extending the Domain to Include Inbound Refinery"

Start Node Manager

Run the setNMProps.sh script and then start Node Manager on WCCHOST1 and on WCCHOST2.

Section 12.4, "Starting Node Manager on WCCHOST1 and WCCHOST2"

Propagate the domain configuration to the Inbound Refinery managed servers

Propagate the start scripts and classpath configuration from the Administration Server's domain directory to the managed server domain directories.

Section 12.5, "Propagating the Domain Configuration to the Managed Server Domain Directories"

Restart the Administration Server for the domain

Stop and then start the Administration Server to make the changes from the previous step take effect.

Section 12.6, "Restarting the Administration Server"

Start the Inbound Refinery managed servers

Start the WLS_IBR1 and WLS_IBR2 managed servers.

Section 12.7, "Starting the Inbound Refinery Managed Servers"

Configure the Inbound Refinery instances

Complete the initial configuration of Inbound Refinery on WLS_IBR1 and WLS_IBR

Section 12.8, "Configuring the Inbound Refineries"

Verify the Inbound Refinery configuration

Verify that a file with an extension recognized as valid for conversion is correctly converted on Content Server.

Section 12.9, "Validating the Configuration of the Inbound Refinery Managed Servers"


12.2 Associating Inbound Refinery Managed Servers with Virtual Host Names

Associate the WLS_IBR1 and WLS_IBR2 servers with the virtual host names WCCHOST1VHN1 and WCCHOST2VHN1. Check that these virtual host names are enabled by DNS or /etc/hosts resolution in your system and that they map to the appropriate VIPs.

For more information, see Section 9.2, "Enabling SOAHOST1VHN1 on SOAHOST1 and SOAHOST2VHN1 on SOAHOST2."

12.3 Extending the Domain to Include Inbound Refinery

To complete the enterprise deployment topology, you must extend the domain created in Section 8, "Creating a Domain for an Enterprise Deployment" to include Oracle WebCenter Content: Inbound Refinery.

Note:

Before performing these steps, back up the domain as described in the Oracle Fusion Middleware Administrator's Guide.

To extend the domain to include Oracle WebCenter Content: Inbound Refinery:

  1. Ensure that the database where you created the repository schema is running. For Oracle RAC databases, it is recommended that all instances are running, so that the validation check later on becomes more reliable.

  2. On SOAHOST1, change the directory to the location of the Oracle Fusion Middleware Configuration Wizard. This is within the Oracle Common home directory (notice that domain extensions are run from the node where the Administration Server resides).

    cd ORACLE_COMMON_HOME/common/bin
    
  3. Start the Configuration Wizard:

    ./config.sh
    
  4. In the Welcome screen, select Extend an existing WebLogic domain, and click Next.

  5. In the WebLogic Domain Directory screen, select the WebLogic domain directory (ORACLE_BASE/admin/domain_name/aserver/domain_name), and click Next.

  6. In the Select Extension Source screen, do the following:

    • Select Extend my domain automatically to support the following added products.

    • Select the following product:

      Oracle Universal Content Management - Inbound Refinery - 11.1.1.0 [wcc]

      This is the selection for Oracle WebCenter Content: Inbound Refinery.

    The following products should already be selected and grayed out. They were selected when you created a domain in Section 8.3, "Running the Configuration Wizard on SOAHOST1 to Create a Domain," or extended the domain in Section 9.3, "Extending the Domain for Oracle SOA Suite Components Using the Configuration Wizard,", Section 10.3, "Extending the Domain to Include WebCenter Content,", or Section 11.3, "Extending the Domain to Include Imaging":

    • Basic WebLogic Server Domain

    • Oracle SOA Suite for developers

    • Oracle SOA Suite

    • Oracle WebCenter Content: Imaging

    • Oracle Universal Content Management - Content Server

    • Oracle Enterprise Manager

    • Oracle WSM Policy Manager

    • Oracle JRF

    Click Next.

  7. In the Configure GridLink RAC Component Schema screen, nothing needs to be done. Inbound Refinery does not have a schema in the database. Click Next to continue.

  8. In the Test JDBC Component Schema screen, nothing needs to be done. Click Next to continue.

  9. In the Optional Configuration screen, select the following options:

    • Managed Servers, Clusters and Machines

    • Deployment and Services

    Click Next.

  10. In the Configure Managed Servers screen (Figure 12-1), add a managed server for Inbound Refinery and configure the Inbound Refinery servers.

    Figure 12-1 Configure Inbound Refinery Managed Servers

    Description of Figure 12-1 follows
    Description of "Figure 12-1 Configure Inbound Refinery Managed Servers"

    One server is created automatically. Rename this server to WLS_IBR1, and add a new server named WLS_IBR2. Give these servers the attributes listed in Table 12-2. Do not modify the other servers that are shown in this screen; leave them as they are.

    Table 12-2 Managed Servers

    Name Listen Address Listen Port SSL Listen Port SSL Enabled

    WLS_IBR1

    WCCHOST1

    16250

    n/a

    No

    WLS_IBR2

    WCCHOST2

    16250

    n/a

    No


    Click Next.

  11. In the Configure Clusters screen, click Add to add the Inbound Refinery cluster shown in Table 12-3. Do not modify the other clusters that appear in this screen; leave them as they are.

    Table 12-3 Cluster Configuration

    Name Cluster Messaging Mode Multicast Address Multicast Port Cluster Address

    IBR_Cluster

    unicast

    n/a

    n/a

    Leave empty


    Click Next.

    Note:

    All Inbound Refinery instances are completely independent. The cluster is used for management purposes only.

  12. In the Assign Servers to Clusters screen (Figure 12-2), add the following items:

    • IBR_Cluster:

      • WLS_IBR1

      • WLS_IBR2

    Figure 12-2 Assign Inbound Refinery Servers to a Cluster

    Description of Figure 12-2 follows
    Description of "Figure 12-2 Assign Inbound Refinery Servers to a Cluster"

    Do not modify the other assignments that appear in this screen; leave them as they are.

    Click Next.

  13. In the Configure Machines screen, click Next.

  14. In the Assign Servers to Machines screen (Figure 12-3), assign the Inbound Refinery managed servers to machines as follows:

    • Assign WLS_IBR1 to WCCHOST1.

    • Assign WLS_IBR2 to WCCHOST2.

    Figure 12-3 Assign Inbound Refinery Servers to Machines

    Description of Figure 12-3 follows
    Description of "Figure 12-3 Assign Inbound Refinery Servers to Machines"

    Click Next.

  15. In the Target Deployments to Clusters or Servers screen, verify the following targets:

    • The usermessagingserver and usermessagingdriver-email deployments should be targeted only to SOA_Cluster. (The usermessaging-xmpp, usermessaging-smpp, and usermessaging-voicexml applications are optional.)

    • WSM-PM should be targeted only to SOA_Cluster.

    • The oracle.rules*, oracle.sdp.* and oracle.soa.* deployments should be targeted only to SOA_Cluster, except for the oracle.soa.workflow.wc library, which should be targeted to both SOA_Cluster and IMG_Cluster.

    Click Next.

  16. In the Target Services to Clusters or Servers screen, click Next.

  17. In the Configuration Summary screen, click Extend.

  18. In the Creating Domain screen, click Done.

  19. Restart the Administration Server to make these changes take effect.

    For more information, see Section 12.6, "Restarting the Administration Server."

12.4 Starting Node Manager on WCCHOST1 and WCCHOST2

To start Node Manager on WCCHOST1 and WCCHOST2 if Node Manager has not started already:

  1. On both WEBHOST1 and WEBHOST2, run the setNMProps.sh script, which is located in the ORACLE_COMMON_HOME/common/bin directory, to set the StartScriptEnabled property to true before starting Node Manager:

    cd ORACLE_COMMON_HOME/common/bin
    
    ./setNMProps.sh
    

    Note:

    You must use the StartScriptEnabled property to avoid class loading failures and other problems. See also Section 16.11.3, "Incomplete Policy Migration After Failed Restart of SOA Server."

    Note:

    If the Inbound Refinery server is sharing the MW_HOME in a local or shared storage with Oracle WebCenter Content, as suggested in the shared storage configuration described in Chapter 3, "Preparing the Network for an Enterprise Deployment," it is not required to run setNMProps.sh again. In this case, Node Manager has already been configured to use a start script and it is likely already running in the node for Oracle WebCenter Content.

  2. Run the following commands on both WCCHOST1 and WCCHOST2 to start Node Manager:

    cd WL_HOME/server/bin
    
    ./startNodeManager.sh
    

12.5 Propagating the Domain Configuration to the Managed Server Domain Directories

To propagate the domain configuration:

  1. Run the pack command on SOAHOST1 to create a template pack using the following commands:

    cd ORACLE_COMMON_HOME/common/bin
    
    ./pack.sh -managed=true -domain=ORACLE_BASE/admin/domain_name/aserver/domain_name -template=edgdomaintemplateIBR.jar -template_name=edgdomain_templateIBR
    
  2. Run the following command on SOAHOST1 to copy the template pack created in the previous step to WCCHOST2:

    Note:

    Assuming that WCCHOST1 shares the ORACLE_HOME with SOAHOST1, the template will be present in the same directory in WCCHOST1; otherwise, copy it also to WCCHOST1.

    scp edgdomaintemplateIBR.jar oracle@WCCHOST2:ORACLE_BASE/product/fmw/oracle_common/common/bin
    
  3. Run the unpack command on WCCHOST1 to unpack the propagated template.

    Note:

    Make sure to run unpack from the ORACLE_COMMON_HOME/common/bin directory, not from WL_HOME/common/bin.

    cd ORACLE_COMMON_HOME/common/bin
    
    ./unpack.sh -domain=ORACLE_BASE/admin/domain_name/mserver/domain_name -template=edgdomaintemplateIBR.jar -app_dir=ORACLE_BASE/admin/domain_name/mserver/applications -overwrite_domain=true
    

    Note:

    The ORACLE_BASE/admin/domain_name/mserver directory must exist before you run unpack. In addition, the ORACLE_BASE/admin/domain_name/mserver/applications directory must be empty.

  4. Repeat step 3 for WCCHOST2.

12.6 Restarting the Administration Server

Restart the Administration Server to make these changes take effect. To restart the Administration Server, stop it first using the Administration Console and then start it again as described in Section 8.4.4, "Starting the Administration Server on SOAHOST1."

12.7 Starting the Inbound Refinery Managed Servers

To start the WLS_IBR1 managed server on WCCHOST1:

  1. Log in to the Oracle WebLogic Server Administration Console at http://ADMINVHN:7001/console.

  2. In the Domain Structure window, expand the Environment node and then select Servers.

  3. On the Summary of Servers page, open the Control tab.

  4. Select WLS_IBR1 from the Servers column of the table.

  5. Click Start.

Repeat these steps to start the WLS_IBR2 managed server on WCCHOST2.

12.8 Configuring the Inbound Refineries

An inbound refinery needs to be accessed only once through HTTP in order to initialize its configuration. This can be done directly, at the managed server's listen address. An inbound refinery should not be placed behind an HTTP server.

All subsequent access to an inbound refinery is through the socket listener. This listener is protected through the incoming socket connection address security filter configured in the next section.

Oracle recommends configuring each Oracle WebCenter Content Server with all Inbound Refinery instances. The process for configuring Oracle WebCenter Content is to add each Inbound Refinery instance as a provider. There are also post-installation steps that must be performed with Inbound Refinery.

The following sections describe the procedures for post-installation configuration of each Inbound Refinery instance:

12.8.1 Configuring Inbound Refinery Settings

To configure the settings for each Inbound Refinery instance:

  1. Access the Inbound Refinery post-installation configuration screen at the following URL, in which N is 1 or 2:

    http://WCCHOSTN:16250/ibr/
    
  2. In the Configuration screen, you will see Inbound Refinery Instance Identifier: name. Set the configuration settings for this instance as follows:

    • Inbound Refinery Instance Folder: Set this to ORACLE_BASE/admin/domain_name/ibr_cluster_name/ibrN. The directory path should be on a shared disk, but should be unique for each Inbound Refinery instance.

    • Native File Repository Location: Set this to ORACLE_BASE/admin/domain_name/ibr_cluster_name/ibrN/vault.

    • WebLayout Folder: Set this to ORACLE_BASE/admin/domain_name/ibr_cluster_name/ibrN/weblayout.

    • User Profile Folders: Set this to ORACLE_BASE/admin/domain_name/ibr_cluster_name/ibrN/data/users/profiles.

    • Incoming Socket Connection Address Security Filter: Set this to a pipe-delimited list of localhost and the server IPs:

      127.0.0.1|WCCHOST1-IP|WCCHOST2-IP|WEBHOST1-IP|WEBHOST2-IP
      

      This enables access from Oracle WebCenter Content Server. The values for WCCHOST1-IP and WCCHOST2-IP should be the IP addresses of the machines with the Oracle WebCenter Content Server instance or instances that will send jobs to Inbound Refinery, not necessarily the IP address of Inbound Refinery. (In the reference topology used in this enterprise deployment guide, however, these IP addresses are the same.)

      This field accepts wildcards in the value; for example, 192.0.2.*. You can change this value later by setting SocketHostAddressSecurityFilter in ORACLE_BASE/admin/domain_name/mserver/domain_name/ucm/ibr/
      config/config.cfg
      and restarting Inbound Refinery.

    • Server Socket Port: Enter an unused port number, such as 5555. This value is the number of the port for calling top-level services. Changing this field value changes the IntradocServerPort entry in ORACLE_BASE/admin/domain_name/mserver/domain_name/ucm/ibr/config/config.cfg. Take note of the port number as you need it later when configuring Oracle WebCenter Content.

    • Server Instance Name: Specify a name for the Inbound Refinery server instance. You can accept the default or change it to a more useful name if you want. Take note of the server name as you need it later when configuring Oracle WebCenter Content.

    You can leave all other fields on the configuration page as they are.

    Click Submit, and you should got the following message:

    Post-install configuration complete. Please restart this node.
    
  3. Restart the Inbound Refinery managed server.

  4. Repeat these steps for all the inbound refineries, using different names for the content folders.

For Inbound Refinery to work properly, you must specify the path to fonts used to generate font images. By default, the font path is set to the font directory in the JVM used by Inbound Refinery: MW_HOME/jdk160_version/jre/lib/fonts. However, the fonts included in the default directory are limited and may cause poor renditions. Also, in some cases if a non-standard JVM is used, then the JVM font path may be different than that specified as the default. If this is the case, an error message is displayed from both Inbound Refinery and Content Server. If this occurs, ensure the font path is set to the directory containing the fonts necessary to properly render your conversions. For more information, see "Specifying the Font Path" in the Oracle WebCenter Content Administrator's Guide for Conversion.

12.8.2 Configuring Document Conversion

To configure document conversion on each Inbound Refinery managed server:

  1. Log in to Inbound Refinery at the following URL, in which N is 1 or 2

    http://WCCHOSTN:16250/ibr/
    
  2. Enable conversion components on Inbound Refinery. The core Inbound Refinery converts files to TIFF web-viewable files and JPEG image thumbnails. To use additional conversion types, you need to enable the necessary components:

    1. Open the Administration tray or menu, then choose Admin Server.

    2. In the Component Manager, select PDFExportConverter in Inbound Refinery and any other components you want. PDFExportConverter uses Outside In to convert documents directly to PDF files. The conversion can be cross-platform and does not require any third-party product. You can enable PDFExportConverter for Inbound Refinery as a server feature. For more information, consult the readme files and the documentation for each component.

    3. Click Update.

    4. Click OK to enable the components.

    5. Restart the Inbound Refinery managed server.

  3. Restart the Administration Server and all Inbound Refinery managed servers.

  4. Set the primary web-viewable conversion to PDF Export:

    1. Select Conversion Settings, then select Primary Web Rendition.

    2. On the Primary Web-Viewable Rendition page, select Convert to PDF using PDF Export.

    3. Click Update to save your changes.

    Inbound Refinery will now use Outside In PDF Export to convert files directly to PDF without the use of third-party applications.

12.8.3 Setting Up Content Server to Send Jobs to Inbound Refinery for Conversion

Before Oracle WebCenter Content Server can send jobs to Inbound Refinery for conversion, you need to perform these setup tasks for each Inbound Refinery managed server:

12.8.3.1 Creating an Outgoing Provider

Before Content Server can send files to Inbound Refinery for conversion, you must set up an outgoing provider from Content Server to each Inbound Refinery with the Handles Inbound Refinery Conversion Jobs option checked.

Perform these tasks to create an outgoing provider for each Inbound Refinery:

  1. Log in to Oracle WebCenter Content Server at the following URL:

    http://WCCHOST1:16200/cs/
    
  2. Open the Administration tray or menu and choose Providers.

  3. In the Create a New Provider section of the Providers page, click Add in the outgoing row.

  4. Enter the following values for the fields:

    • Provider Name: Any short name with no spaces. It is a good idea to use the same value as the Instance Name value

    • Provider Description: Any text string.

    • Server Host Name: The name of the host machine where the Inbound Refinery instance is running: WCCHOST1.

    • HTTP Server Address: The address of the Inbound Refinery instance: WCCHOST1:16250.

    • Server Port: The value of the Server Socket Port field for the Inbound Refinery instance as specified in Section 12.8.1, "Configuring Inbound Refinery Settings", for example 5555. This is the IntradocServerPort value in the Content Server's config.cfg file.

    • Instance Name: The server instance name for Inbound Refinery as specified in Section 12.8.1, "Configuring Inbound Refinery Settings." This is the IDC_Name value in the Content Server's config.cfg file.

    • Relative Web Root: The web root of the Inbound Refinery instance: /ibr/.

  5. Under Conversion Options, check Handles Inbound Refinery Conversion Jobs.

    Do not check Inbound Refinery Read Only Mode.

  6. Click Add.

  7. Restart Oracle WebCenter Content Server.

  8. Go back to the Providers page, and check that the Connection State value is good for the provider.

    If the value is not good, double-check that you entered all the preceding entries correctly, and check that the Content Server and Inbound Refinery instances can ping each other.

For more information about setting up providers, see "Configuring Content Server and Refinery Communication" in Oracle WebCenter Content Administrator's Guide for Conversion.

12.8.3.2 Enabling Components for Inbound Refinery on Content Server

Some conversion types require helper components to be enabled on Content Server. The InboundRefinerySupport component must always be enabled on any Content Server instance that uses Inbound Refinery for document conversion. It is enabled by default on a new Content Server installation.

To enable Inbound Refinery components on Content Server:

  1. Log in to Oracle WebCenter Content Server at the following URL:

    http://WCCHOST1:16200/cs/
    
  2. Open the Administration tray or menu, then choose Admin Server, and then Component Manager.

  3. Under Inbound Refinery, make sure InboundRefinerySupport is selected, and select any other components, such as XMLConverterSupport, that you want to enable.

  4. Click Update.

  5. Restart Oracle WebCenter Content Server.

12.8.3.3 Selecting File Formats To Be Converted

To tell Oracle WebCenter Content Server which files to send to Inbound Refinery to be converted, you need to select file formats.

To select file formats to be converted:

  1. Log in to Oracle WebCenter Content Server at the following URL:

    http://WCCHOST1:16200/cs/
    
  2. Open the Administration tray or menu, then choose Refinery Administration, and then File Formats Wizard to open the File Formats Wizard page, which specifies what file formats will be sent to Inbound Refinery for conversion when they are checked into Content Server.

  3. Select the formats you want converted, such as doc, dot, docx, and dotx for Microsoft Word documents.

  4. Click Update.

You can also select file formats with the Configuration Manager, with more fine-grained control, including file formats that wizard does not list. For more information, see "Using the File Formats Wizard" and "Using the Configuration Manager" in Oracle WebCenter Content Administrator's Guide for Conversion.

12.9 Validating the Configuration of the Inbound Refinery Managed Servers

To ensure that the Inbound Refinery managed servers you have created are properly configured, validate the configuration by logging in to Oracle WebCenter Content Server and verifying that a file with an extension recognized as valid for conversion is correctly converted.

For example, if you selected docx as a format to be converted, you can convert a Microsoft Word document with a .docx extension to PDF format.