1. Enterprise Deployment Guide for Oracle WebCenter Content
  2. Configuring the Enterprise Deployment
  3. Extending the Domain to Include Inbound Refinery

14 Extending the Domain to Include Inbound Refinery

You need to perform certain tasks in order to extend the enterprise deployment domain to include Inbound Refinery software.

Parent topic: Configuring the Enterprise Deployment

Overview of Extending the Domain to Include Inbound Refinery

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, each installed and configured on a separate machine. In the reference Oracle WebCenter Content enterprise deployment topology, Inbound Refinery will be configured on the same machine as Content Server.

Even though multiple Managed Servers are created in the process of extending the domain with Inbound Refinery in this enterprise deployment topology, each Inbound Refinery instance is completely independent. Inbound Refinery does not run in a cluster.

Parent topic: Extending the Domain to Include Inbound Refinery

Extending the Domain for Inbound Refinery

The instructions for extending the existing enterprise deployment domain with the Inbound Refinery software are detailed in this section.

Parent topic: Extending the Domain to Include Inbound Refinery

Starting the Configuration Wizard

Start the Configuration Wizard as the first step to extend the existing enterprise deployment domain.

Note:

If you added any customizations directly to the start scripts in the domain, those are overwritten by the configuration wizard. To customize server startup parameters that apply to all servers in a domain, you can create a file called setUserOverridesLate.sh and configure it, for example, add custom libraries to the WebLogic Server classpath, specify Additional JAVA command line options for running the servers, or specify additional environment variables. Any customizations you add to this file are preserved during domain upgrade operations, and are carried over to remote servers when using the pack and unpack commands.

To start the Configuration Wizard:

  1. From the WebLogic Server Console, stop any managed servers that are modified by this domain extension. Managed Servers that are not effected can remain on-line.
  2. For any managed servers to be modified, verify that the managed server shutdown has completed.
  3. Stop the Administration Server once all managed servers are in a steady state.
  4. Navigate to the following directory and start the WebLogic Server Configuration Wizard.
    cd ORACLE_HOME/oracle_common/common/bin
./config.sh

Parent topic: Extending the Domain for Inbound Refinery

Navigating the Configuration Wizard Screens to Extend the Domain

Follow the instructions in this section to update and configure the domain for the topology.

Note:

You can use the same procedure described in this section to extend an existing domain. If your needs do not match the instructions given in the procedure, be sure to make your selections accordingly, or refer to the supporting documentation for additional details.

Domain creation and configuration includes the following tasks:

Task 1   Selecting the Domain Type and Domain Home Location

On the Configuration Type screen, select Update an existing domain.

In the Domain Location field, select the value of the ASERVER_HOME variable, which represents the complete path to the initial Administration Server domain home you created.

For more information about the directory location variables, see File System and Directory Variables Used in This Guide.

Tip:

More information about the other options on this screen can be found in Configuration Type in Creating WebLogic Domains Using the Configuration Wizard.

Click Next to proceed.

Task 2   Selecting the Configuration Template

On the Templates screen, make sure Update Domain Using Product Templates is selected, then select the following templates:

  • Oracle Universal Content Management - Inbound Refinery - 12.2.1.3.0 [wccontent]

    The following additional templates should already be selected, because they were used to create the initial domain:

    • Oracle Enterprise Manager - 12.2.1.3.0 [em]

    • Oracle SOA Suite - 12.2.1.3.0 [soa]

    • Oracle WebCenter Content - 12.2.1.3.0 [wcc]

    • Oracle WSM Policy Manager - 12.2.1.3.0 [oracle_common]

    • Oracle JRF - 12.2.1.3.0 [oracle_common]

    • WebLogic Coherence Cluster Extension - 12.2.1.3.0 [wlserver]

Tip:

More information about the options on this screen can be found in Templates in Creating WebLogic Domains Using the Configuration Wizard.

Click Next to proceed.

Task 3   Providing the GridLink Oracle RAC Database Connection Details

On the GridLink Oracle RAC Component Schema screen, click Next.

Task 4   Testing the JDBC Connections

Click Next to continue.

Task 5   Selecting Advanced Configuration

To complete domain configuration for the topology, select the following option on the Advanced Configuration screen:

Topology

Click Next to proceed.

Task 6   Configuring Managed Servers

On the Managed Servers screen, a new Managed Server appears in the list of servers.

Perform the following tasks to modify the default Managed Server and create a second Managed Server:

  1. Rename the default Managed Server to WLS_IBR1.

  2. Click Add to create a new Managed Server and name it WLS_IBR2.

    Tip:

    The server names recommended here will be used throughout this document. If you choose different names be sure to replace them as needed.

  3. Use the information in the following table to fill in the rest of the columns for each Managed Server.

Table 14-1 Values Required for Each Oracle Inbound Refinery Server

Server Name Listen Address Listen Port Enable SSL SSL Listen Port Server Group

WLS_IBR1

WCCHOST1

16250

No

Disabled

IBR-MGD-SVR

WLS_IBR2

WCCHOST2

16250

No

Disabled

IBR-MGD-SVR

Tip:

More information about the options on the Managed Server screen can be found in Managed Servers in Creating WebLogic Domains Using the Configuration Wizard.

Click Next to proceed.

Task 7   Configuring a Cluster

In this task, you create a cluster of Managed Servers to which you can target the Oracle Inbound Refinery software.

Use the Clusters screen to create a new cluster:

  1. Click the Add button.

  2. Specify IBR_Servers in the Cluster Name field.

  3. From the Dynamic Server Groups drop-down list, select Unspecified.

  4. Click Next to proceed to the next screen.

Note:

By default, server instances in a cluster communicate with one another using unicast. If you want to change your cluster communications to use multicast, refer to "Considerations for Choosing Unicast or Multicast" in Administering Clusters for Oracle WebLogic Server.

Tip:

More information about the options on this screen can be found in Clusters in Creating WebLogic Domains Using the Configuration Wizard.

Task 8   Assigning Server Templates

Click Next to proceed to the next screen.

Task 9   Configuring Dynamic Servers
Verify that all dynamic server options are disabled for clusters that are to remain as static clusters.

  1. Confirm that the Dynamic Cluster, Calculated Listen Port, and Calculated Machine Names checkboxes on this screen are unchecked.

  2. Confirm the Server Template selection is Unspecified.

  3. Click Next to proceed.

Task 10   Assigning Managed Servers to the Cluster

Use the Assign Servers to Clusters screen to assign WLS_IBR1 and WLS_IBR2 to the new cluster IBR_Servers:

  1. In the Clusters pane, select the cluster to which you want to assign the servers; in this case, IBR_Servers.

  2. In the Servers pane, assign WLS_IBR1 to IBR_Servers by doing one of the following:

    • Click once on WLS_IBR1 Managed Server to select it, then click on the right arrow to move it beneath the selected cluster in the Clusters pane.

    • Double-click WLS_IBR1 to move it beneath the selected cluster in the clusters pane.

  3. Repeat to assign WLS_IBR2 to IBR_Servers.

    Tip:

    More information about the options on this screen can be found in Assign Servers to Clusters in Creating WebLogic Domains Using the Configuration Wizard.

  4. Click Next to proceed.

Task 11   Configuring Coherence Clusters

Use the Coherence Clusters screen to configure the Coherence cluster that is automatically added to the domain. Leave the port number value at 9991, as it was defined during the initial Infrastructure domain creation.

Note:

For Coherence licensing information, refer to Oracle Coherence in Oracle Fusion Middleware Licensing Information.

Click Next to proceed.

Task 12   Verifying the Existing Machines

Under the Unix Machine tab, verify the names of the machines you created when creating the initial Infrastructure domain.

Click Next to proceed.

Task 13   Assigning Servers to Machines

Use the Assign Servers to Machines screen to assign the Oracle Inbound Refinery Managed Servers you just created to the corresponding machines in the domain.

Assign WLS_IBR1 to WCCHOST1, and assign WLS_IBR2 to WCCHOST2.

Tip:

More information about the options on this screen can be found in Assign Servers to Machines in Creating WebLogic Domains Using the Configuration Wizard.

Click Next to proceed.

Task 14   Reviewing Virtual Targets

Click Next to proceed to the next screen.

Task 15   Reviewing Partitions

Click Next to proceed to the next screen.

Task 16   Reviewing Your Configuration Specifications and Configuring the Domain

The Configuration Summary screen contains the detailed configuration information for the domain. Review the details of each item on the screen and verify that the information is correct.

You can go back to any previous screen if you need to make any changes, either by using the Back button or by selecting the screen in the navigation pane.

Click Update to execute the domain extension.

Tip:

More information about the options on this screen can be found in Configuration Summary in Creating WebLogic Domains Using the Configuration Wizard.

Task 17   Writing Down Your Domain Home and Administration Server URL

The Configuration Success screen will show the following items about the domain you just configured:

  • Domain Location

  • Administration Server URL

You must make a note of both items as you will need them later; the domain location is needed to access the scripts used to start the Node Manager and Administration Server, and the URL is needed to access the Administration Server.

Click Finish to dismiss the Configuration Wizard.

Task 18   Start the Administration Server

Start the Administration Server to ensure the changes you have made to the domain have been applied.

Parent topic: Extending the Domain for Inbound Refinery

Completing Postconfiguration and Verification Tasks for Inbound Refinery

After extending the domain with the Inbound Refinery software, consider the following post-configuration and verification tasks.

Parent topic: Extending the Domain to Include Inbound Refinery

Propagate the Domain Configuration Updates for Inbound Refinery

Propagate the start scripts and classpath configuration from the Administration Server's domain directory to the Managed Server domain directory. To propagate the domain configuration to the Inbound Refinery Managed Servers:
  1. Create a copy of the Managed Server domain directory and the Managed Server applications directory.
  2. Run the following pack command on WCCHOST1 to create a template pack:
    cd ORACLE_COMMON_HOME/common/bin

./pack.sh -managed=true -domain=ASERVER_HOME -template=edgdomaintemplateExtIBR.jar -template_name=edgdomain_templateIBR
  3. Run the following unpack command on WCCHOST1 to propagate the template created in the preceding step to the WLS_IBR1 domain directory:
    cd ORACLE_COMMON_HOME/common/bin

./unpack.sh -domain=MSERVER_HOME -template=edgdomaintemplateExtIBR.jar -app_dir=APPLICATION_HOME -overwrite_domain=true
  4. Run the following command on WCCHOST1 to copy the template pack created in step 1 to WCCHOST2:
    scp edgdomaintemplateIBR.jar oracle@WCCHOST2:ORACLE_COMMON_HOME/common/bin
  5. Run the unpack command on WCCHOST2 to unpack the propagated template to the WLS_IBR1 domain directory.
    cd ORACLE_COMMON_HOME/common/bin

./unpack.sh -domain=MSERVER_HOME -template=edgdomaintemplateExtIBR.jar -app_dir=APPLICATION_HOME -overwrite_domain=true

Parent topic: Completing Postconfiguration and Verification Tasks for Inbound Refinery

Starting the Node Manager in the Managed Server Domain Directory

Follow these steps to start the Node Manager from the Managed Server home:

  1. On WCCHOST1, navigate to the following directory:

    MSERVER_HOME/bin

  2. Use the following command to start the Node Manager:

    nohup ./startNodeManager.sh > ./nodemanager.out 2>&1 &

  3. Change directory to the following directory on WCCHOST2 and repeat the preceding step.

    MSERVER_HOME/bin

For information about additional Node Manager configuration options, see Administering Node Manager for Oracle WebLogic Server.

Parent topic: Completing Postconfiguration and Verification Tasks for Inbound Refinery

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 as the weblogic_wcc user at:
    http://admin.example.com/console
  2. Start the WLS_IBR1 Managed Server through the Administration Console, as follows:
    1. Expand the Environment node in the Domain Structure tree on the left.
    2. Click Servers.
    3. On the Summary of Servers page, click the Control tab.
    4. Select WLS_IBR1 from the Servers column of the table.
    5. Click Start.
  3. Verify that the server status is reported as Running in the Administration Console.
    • If the server is shown as Starting or Resuming, wait for the server status to change to Started.
    • If another status is reported (such as Admin or Failed), check the server output log files for errors.
  4. Repeat the preceding steps to start the WLS_IBR2 Managed Server on WCCHOST2.

Parent topic: Completing Postconfiguration and Verification Tasks for Inbound Refinery

Configuring the Inbound Refinery Managed Servers

To initialize the configuration of an Inbound Refinery Managed Server, you need to access it only once through HTTP. You can do this directly at the Managed Server's listen address. An Inbound Refinery instance should not be placed behind an HTTP server.

All subsequent access to the Inbound Refinery instance 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 Content Server instance with all Inbound Refinery instances. The process for configuring Content Server is to add each Inbound Refinery instance as a provider. You also need to perform some post-installation steps with Inbound Refinery.

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

Parent topic: Extending the Domain to Include Inbound Refinery

Configuring Inbound Refinery Settings

After starting the Inbound Refinery Managed Servers, configure the settings for each server on its post-installation configuration screen.

To configure the settings for each Inbound Refinery instance, complete the following steps:
  1. Create unique IBR directories on the ORACLE_RUNTIME shared filesystem for each IBR server as required for the Oracle WebCenter Content Inbound Refinery configuration. The Oracle WebCenter Content Inbound Refinery configuration requires a unique and separate directory for each IBR instance's runtime files. The EDG architecture recommends using the ORACLE_RUNTIME shared filesystem consistently for all runtime file-based data storage. The recommended base path for the Oracle WebCenter Content Inbound Refinery runtime file storage is ORACLE_RUNTIME/domain_name/IBR_Servers/

    Note:

    The IBR servers do not share file-based data between instances. Unlike the Content Server instances, there is no product-specific requirement to implement a shared filesystem for the IBR data. Use of the shared filesystem for IBR data is for architectural consistency and DR replication efficiency.
    Run the following commands to create the required unique subdirectories for each IBR managed server:
    mkdir -p ORACLE_RUNTIME/domain_name/IBR_Servers/ibr1/vault 
mkdir -p ORACLE_RUNTIME/domain_name/IBR_Servers/ibr1/weblayout 
mkdir -p ORACLE_RUNTIME/domain_name/IBR_Servers/ibr1/data/users/profiles  
mkdir -p ORACLE_RUNTIME/domain_name/IBR_Servers/ibr2/vault 
mkdir -p ORACLE_RUNTIME/domain_name/IBR_Servers/ibr2/weblayout 
mkdir -p ORACLE_RUNTIME/domain_name/IBR_Servers/ibr2/data/users/profiles
  2. Access the Inbound Refinery post-installation configuration screen at the following URL for each WCCHOST:
    http://WCCHOSTN:16250/ibr/
  3. On the Configuration screen, you will see Inbound Refinery Instance Identifier: name. Set the remaining configuration settings for this instance as follows.

    Note:

    Each Inbound Refinery instance and associated runtime file repository directory are unique and independent of the other instances. Use the specific directory paths just created in this section for the corresponding configuration settings of each instance. Inbound Refinery Instance Folder: Set this to ORACLE_RUNTIME/domain_name/IBR_Servers/ibrN

    • Inbound Refinery Instance Folder: Set this to ORACLE_RUNTIME/domain_name/IBR_Servers/ibrN

      For example: /u01/oracle/runtime/wccedg_domain/IBR_Servers/ibr1

    • Native File Repository Location: Set this to ORACLE_RUNTIME/domain_name/IBR_Servers/ibrN/vault

      For example: /u01/oracle/runtime/wccedg_domain/IBR_Servers/ibr1/vault

    • WebLayout Folder: Set this to ORACLE_RUNTIME/domain_name/IBR_Servers/ibrN/weblayout

      For example: /u01/oracle/runtime/wccedg_domain/IBR_Servers/ibr1/weblayout

    • User Profile Folders: Set this to ORACLE_RUNTIME/domain_name/IBR_Servers/ibrN/data/users/profiles

      For example: /u01/oracle/runtime/wccedg_domain/IBR_Servers/ibr1/data/users/profiles

    • Incoming Socket Connection Address Security Filter: A pipe-delimited list of localhost and the server IP addresses:

      127.0.0.1|0:0:0:0:0:0:0:1|WCCHOST1-IP|WCCHOST2-IP|WEBHOST1-IP|WEBHOST2-IP

      This setting enables access from Content Server. The values for WCCHOST1-IP and WCCHOST2-IP should be the IP addresses of the machines with the 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.)

      The Incoming Socket Connection Address Security Filter: field accepts wildcards in the value; for example, 192.0.2.*.

      You can change this value later by setting SocketHostAddressSecurityFilter in the/u02/oracle/runtime/wccedg_domain/IBR_Servers/ibrN/config/config.cfg file and then restarting the Inbound Refinery Managed Server.

      Where N is 1 for http://WCCHOST1:16250/ibr/ and N is 2 for http://WCCHOST2:16250/ibr/

    • Server Socket Port: Enter an unused port number, such as 5555. This value is the number of the port for calling top-level services.

      Take note of the port number because you need it later for configuring Oracle WebCenter Content.

      Changing this field value changes the IntradocServerPort entry in /u01/oracle/runtime/wccedg_domain/IBR_Servers/ibrN/config/config.cfg

      Where N is 1 for http://WCCHOST1:16250/ibr/ and N is 2 for http://WCCHOST2:16250/ibr/

    • Server Instance Name: Specify a name for the Inbound Refinery server instance.

      You can accept the default value or change it to a name that is more useful to you. Take note of the server name because you will need it later for configuring Oracle WebCenter Content.

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

    Click Submit, and you should get the following message:

    Post-install configuration complete. Please restart this node.
  4. Restart the Inbound Refinery Managed Server, using the WebLogic Server Administration Console.
  5. Repeat the preceding steps for each Inbound Refinery instance, using different names for the content folders.

Parent topic: Configuring the Inbound Refinery Managed Servers

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 the setup tasks described in the following sections for each Inbound Refinery Managed Server.

  • 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.
  • 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.
  • Selecting File Formats To Be Converted
    To tell Content Server which files to send to Inbound Refinery to be converted, you need to select file formats.

Parent topic: Configuring the Inbound Refinery Managed Servers

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.

To create an outgoing provider for each Inbound Refinery instance:
  1. Log in to Content Server at the following URL:
    http://WCCHOST1:16200/cs/
  2. Open the Administration tray or menu, then choose Providers.
  3. In the Create a New Provider table 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 Configuring Inbound Refinery Settings; for example, 5555. This is the IntradocServerPort value in the Inbound Refineryconfig.cfg file.

    • Instance Name: The server instance name for Inbound Refinery as specified in Configuring Inbound Refinery Settings. This is the IDC_Name value in the Inbound Refinery 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 the Inbound Refinery Managed Server and Oracle WebCenter Content Server (WebCenter Content Managed Server), using the WebLogic Server Administration Console.
  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.

  9. Complete steps 1 through 8 for the second IBR server.
For more information about setting up providers, see "Configuring Content Server and Refinery Communication" in Oracle Fusion Middleware Managing Oracle WebCenter Content.
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 Content Server at the following URL:
    https://wcc.example.com/cs
  2. From the Administration tray or menu, choose Admin Server, then Component Manager.
  3. On the Component Manager page, select Inbound Refinery, then select components that you want to enable under Inbound Refinery, such as XMLConverterSupport, and then click Update.
  4. Restart both Content Servers by restarting the WebCenter Content Managed Servers, using the WebLogic Server Administration Console.
Selecting File Formats To Be Converted

To tell 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 Content Server at the following URL:
    https://wcc.example.com/cs/
  2. Open the Administration tray or menu, then choose Refinery Administration, and then File Formats Wizard to open the File Formats Wizard page.

    This page 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 the wizard does not list. See Managing File Types in Oracle Fusion Middleware Managing Oracle WebCenter Content.

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 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.

For information about the check-in and check-out procedures, see "Uploading Documents" and "Checking Out and Downloading Files" in Oracle Fusion Middleware Using Oracle WebCenter Content.

For information about the conversion process, see "Configuring Content Servers to Send Jobs to Refineries" in Oracle Fusion Middleware Managing Oracle WebCenter Content.

Parent topic: Extending the Domain to Include Inbound Refinery