3 Configuring Capture

This chapter describes the configuration options available to an Oracle WebCenter Enterprise Capture administrator and how they are accessed.

This chapter includes the following sections:

3.1 Overview of Configuring Oracle WebCenter Enterprise Capture

System administrators use Oracle Enterprise Manager functions for:

By default, errors, warnings, and major application lifecycle events are logged. You can progressively increase the log level to cause configuration messages, debug messages, and trace messages to be logged. See Configuring and Viewing Capture Log Files for more information on how to configure log files.

3.2 Managing Capture Settings in Enterprise Manager

The system administrator can make changes to the Capture system configuration from the System Configuration page in Oracle Enterprise Manager Fusion Middleware Control. The system administrator can change the following settings from the System Configuration page:

  • System Properties

  • Import Processor Settings

  • SMTP Settings for E-mail broadcasts

3.2.1 Modifying System Configuration Settings

To modify the system configuration:

  1. Log in to Oracle Enterprise Manager using the steps listed in Starting Capture Functions in Enterprise Manager.
  2. Click the Capture server in the top left pane to display the Capture menu options.
  3. To modify the system configuration, select Configuration, and then System Configuration from the Capture menu. The System Configuration page displays.

    The following table lists all the configuration parameters that you can set in this page.

Table 3-1 System Configuration Parameters

Group Parameter Description

System Properties

This group contains configuration settings for batches and client bundles.

Capture System ID

A value that uniquely identifies the Capture system. Enter a value that uniquely identifies the Capture system on the network.

Value: Any string, for example, Capture_01.

Default value: Capture_01

Maximum batches to return per search

Specify the maximum number of batches to return per search.

Value: Any integer, for example, 100.

Default value: 100

Days to maintain cache on client workstations

Specify the number of days a batch will remain cached on client workstations. If a batch is locked, it will not be deleted from the client workstation's cache. No warning is given when a batch is deleted from the cache.

Value: Any integer, for example, 3.

Default value: 5

Frequency to poll for client bundles (seconds)

Specify the frequency that the Capture server checks its client bundles directory for updates. This is measured in seconds.

Default value: 30

GD Font Path

For Unix systems, specify the location of the Unix font directory. This path is used by the PDF Image Only document output format driver to render the fonts for PDF documents.

Value: A valid directory path, for example, /usr/share/X11/fonts.

Import Processor Settings

This group contains configuration settings for the Import Processor.

Frequency to check for new or updated jobs (seconds)

Specify how often an internal timer will fire to check for Import Processor jobs that need to be processed. This is measured in seconds.

Value: Any integer, for example, 60.

Default value: 60

Import HA token expiration (minutes)

Specify the duration for which an Import HA Token is valid. This is measured in minutes. An Import HA Token uniquely identifies and maintains processing state of an object being imported such as an email, file, or list file.

Value: Any integer, for example, 60.

Default value: 5

SMTP Settings for E-mail broadcasts

This group contains settings for configuring an email account to use when sending error messages if an error occurs during batch processing.

SMTP Host

Specify an SMTP Server Host.

Value: Any string, for example, test.example.com.

SMTP Port

Specify the SMTP Server Port.

Value: Any valid port number, for example, 25.

SMTP User ID

Specify a user ID for the SMTP server.

Value: Any string, for example, TEST01.

Change SMTP Password

Specify a value for the SMTP password.

Value: Any string

Confirm SMTP Password

Re-enter the new SMTP password.

Value: Any string

SMTP SSL

Specify if the SMTP server should use SSL security.

SMTP STARTTLS

Specify if the SMTP server should use start TLS.

SMTP Message From

Specify a value for the From field for SMTP messages.

Value: Any string

3.2.2 Managing Client Bundles

Bundles are program modules that are downloaded and executed by the Capture client. As a system administrator, you may need to delete selected bundles, search for new or updated bundles, and apply them.

To manage client bundles from Oracle Enterprise Manager:

  1. Log in to Oracle Enterprise Manager using the steps listed in Starting Capture Functions in Enterprise Manager.
  2. Click the Capture server in the top left pane to display the Capture menu options.
  3. To manage client bundles, select Configuration, and then Bundle Manager from the Capture menu. The Bundle Manager page displays.
  4. To delete orphaned client bundles, from the list of installed client bundles, select the ones you want to delete, then click Delete selected bundles.
  5. To scan for and install updated client bundles, click Scan for Client Bundles. Any updated client bundled are installed.

    Note:

    To install a new bundle, copy the bundle archive to the <ECM_HOME>/wccapture/capture/clientbundles directory, and then click Scan for Client Bundles.

  6. Click Apply to save your changes. You may need to restart the Capture server for the changes to take effect.

3.3 Managing Users and Security

This section covers the following topics:

3.3.1 About Security and Capture Roles

Capture includes the following roles:

3.3.1.1 System Administrator

The system administrator is a super user that has complete control over the Capture system's configuration and administration. This user can give permissions to access the system to others. The system administrator can perform the following tasks:

  • Access the Enterprise Manager application to configure system parameters, assign roles to Capture users and groups, view performance data, and manage system logs.

  • Apply system updates.

  • Grant the workspace manager role to individuals or groups of individual users.

3.3.1.2 Capture Workspace Manager

A workspace manager is allowed to create Capture workspaces, and create client profiles and batch processing jobs for processes that act upon batches within the workspace. In addition, the workspace manager also grants other users permission to access the workspace in the workspace manager, workspace viewer, or user roles.

3.3.1.3 Capture Workspace Viewer

A workspace viewer is granted read-only permission to the workspace for the purpose of reviewing the workspace configuration, which includes client profiles and batch processor job configurations.

3.3.1.4 Capture Client User

A Capture client user may create, update, and delete batch-related content within a workspace, including batches, batch items, documents, and pages.

3.3.2 Assigning Capture Roles in Oracle Enterprise Manager

You can create Capture users in Oracle WebLogic Server Administration Console, and then assign roles to them in Oracle Enterprise Manager.

To create an Oracle WebCenter Enterprise Capture user:

  1. Log into the WebLogic Server Administration Console using the steps listed in Starting Capture Functions in the WebLogic Server Console.

  2. Navigate to the capture_domain within WebLogic Server, and then click Security Realms.

  3. In the table under the Summary of Security Realms section, click myrealm, the built-in realm that works with the integrated LDAP.

  4. Select the Users and Groups tab and then the Users subtab.

  5. Under the Users section, click New to display the Create a New User section.

  6. In the Name field, specify a name, for example, Workspace Manager.

  7. In the Password field, specify a password.

  8. In the Confirm Password field, enter the password again, and then click OK.

  9. Create another user by performing steps 4 to 8.

You can assign LDAP users and groups to Capture roles in Oracle Enterprise Manager.

To assign a Capture role to users and groups:

  1. Log in to Oracle Enterprise Manager using the steps listed in Starting Capture Functions in Enterprise Manager.
  2. Navigate to the capture_domain within the WebLogic Domain.
  3. Right-click the capture_domain, select Security, and then Application Roles. The Application Roles page displays.
  4. In the Application Stripe field, select capture, and then click the Search application roles icon to display the Capture application roles.
  5. Select a role from the list, for example, CaptureWorkspaceManager, then click Edit. The Edit Application Role page for the selected role displays.
  6. In the Edit Application Role page, under Members, click Add.
  7. In the Add Principal dialog box, search for users or groups that you want to add to the selected Capture role.
  8. Click OK to add the selected user or group.
  9. Repeat steps 6 to 8 to add more users or groups to the selected role.

    Note:

    After a user has been granted the CaptureWorkspaceManager role, that user can sign in to the workspace console, create a workspace, and grant Capture access to other LDAP users who have been assigned Capture roles.

    Note:

    You must assign the CaptureWorkspaceManager and CaptureUser roles to provide access to the Capture workspace console and the Capture client. Only members of the CaptureUser role can use the Capture client.

  10. Click OK.
  11. Add users and groups to the other Capture roles by performing steps 5 to 10.

3.3.3 About Authentication

Authentication is handled by the application server. Capture's user login, access, and authentication are integrated with Oracle WebLogic Server and Oracle Platform Security Services (OPSS). Once authenticated, users' permissions are dictated by application role membership and the workspaces and Capture resources to which they have been granted permission. Within Capture, workspace managers grant access to users or groups. For example, a workspace manager assigns a user group granted the Capture user role to a client profile within the workspace.

3.3.4 About SSL

Capture supports communication between the client and server using HTTP or HTTPS application protocols. If the Capture client is accessed outside the protection of an organization's firewall, the application server's web container should be configured to require HTTPS connections to ensure that all sensitive information is properly secured. SSL applies to the managed server and encompasses both the client and workspace console. Therefore, configuring the server to use SSL affects both the client and workspace console web applications. See Configuring SSL in Oracle Fusion Middleware in Administering Oracle Fusion Middleware.

3.4 Browsing Capture MBeans

Java Management Beans, called MBeans, are part of the greater Java Management eXtensions (JMX) standard which defines ways for administration applications to configure and control Java applications externally. At installation, Capture registers its MBeans with the hosting application server's MBean server. This allows other applications to interact with Capture's configuration data. This includes WebLogic Scripting Tool (WLST) and Oracle Enterprise Manager MBean browser.

3.4.1 Viewing Capture MBeans

If you use Oracle Enterprise Manager to monitor server performance, you may want to also use the Enterprise Manager System MBean Browser to view Oracle WebCenter Enterprise Capture MBean values.

To view Capture MBeans using the System MBean Browser:

  1. Log in to Oracle Enterprise Manager using the steps listed in Starting Capture Functions in Enterprise Manager.
  2. Click the Capture server in the top left pane to display the Capture menu options.
  3. To view Capture MBeans, select System MBean Browser from the Capture menu. The System MBean Browser page displays.
  4. In the left navigation pane, under Application Defined MBeans, expand oracle.capture. Select the appropriate server.
  5. Expand the appropriate server.
  6. Expand the Capture application within the selected server.
  7. Expand config.
  8. Click Config. The list of Capture MBeans displays in the right pane.

The Capture MBeans can be configured from the System Configuration page in Oracle Enterprise Manager. See Managing Capture Settings in Enterprise Manager.

You can also use WLST to view Capture MBeans. See Oracle WebCenter Enterprise Capture Custom WLST Commands in WebCenter WLST Command Reference.

3.5 Configuring High Availability for Oracle WebCenter Enterprise Capture

There are special considerations to keep in mind when you configure high availability for Oracle WebCenter Enterprise Capture.

3.5.1 About Creating a WebCenter Enterprise Capture Domain with Oracle SOA

If you create a WebCenter Enterprise Capture domain with an Oracle SOA component, you must select the JRF-MAN-SVR and WSMPM-MAN-SVR server groups. These server groups ensure that the oracle JRF and Oracle Web Services Manager (OWSM) services target the Managed Servers you are creating.

3.5.2 About Scaling Out WebCenter Enterprise Capture and Configuring OWSM

OWSM uses cross-component wiring to auto-discover the Policy Manager in a domain. When you use the Configuration Wizard to create or update a domain that includes OWSM, Policy Manager URLs publish to the Local Service table.

OWSM Agent is automatically wired to the OWSM Policy Manager using endpoint entries published to the Local Service table. If, however, you change the domain using tools other than the Configuration Wizard (such as WebLogic Administration Console, Fusion Middleware Control, or WLST), any changes to the Policy Manager URL automatically publish to the Local Service table but the OWSM Agent client isn't automatically bound to the new URL. In this case, you must manually bind OWSM Agent to the Policy Manager URL.

For more, see Verifying Agent Bindings Using Fusion Middleware Control in Oracle Fusion Middleware Securing Web Services and Managing Policies with Oracle Web Services Manager.