Skip Headers
Oracle® Distributed Document Capture/Oracle® Document Capture Administrator's Guide
Release 10gR3
E13871-01
  Go To Documentation Library
Library
Go To Product List
Product
Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
 
Next
Next
 

6 Administering Recognition Server

This section covers these topics:

For background information about Recognition Server, see "About Recognition Server".

6.1 Starting, Pausing and Activating the Recognition Server

  1. Start the Recognition Server from the list of programs on the Start menu.

    Recognition Server starts in an active state if there are scheduled jobs. However, Recognition Server does not begin processing jobs for 30 seconds, allowing you to pause the server if you do not want it to process any scheduled jobs.

  2. Activate or pause the server as needed.

    Choose Pause on the Server menu to make changes to settings or batch jobs. Choose Activate on the Server menu to enable scheduled batch jobs to process.

6.2 Configuring Recognition Server

This section covers the following topics:

See "About Recognition Server" for more information.

6.2.1 Setting Up Unattended Login

Follow these steps to specify a login user name and password so Recognition Server will start up without requiring login information.

  1. If needed, pause the server by choosing Pause from the Server menu.

  2. Choose General Settings from the Setup menu.

  3. On the Login tab, select the Unattended Login field.

  4. Enter a username and password for login.

    If you selected Windows domain security as your security model, use the format \\domain\userID in the User ID field (for example, \\domain2\jdoe) to specify the domain along with the user name. For unattended login, the user must be added as an individual Capture user. See "Add User or Group Screen (Windows Domain Security)".

  5. Activate the server by choosing Activate from the Server menu.

6.2.2 Setting Up Email Notification for Processing Errors

  1. If needed, pause the server by choosing Pause from the Server menu.

  2. Choose General Settings from the Setup menu.

  3. On the Email tab, select the Send On Error field.

  4. Specify email server and authorization settings.

  5. Identify email recipients, separating multiple email addresses with a semicolon (;).

  6. Click the Test Email button to send an email message that tests the settings.

  7. Activate the server by choosing Activate from the Server menu.

6.2.3 Setting Up Activity Logging

Follow these steps to specify how Recognition Server activity is logged and the number of days log files are retained. You specify the log file path in the batch jobs options, as described in "Adding Batch Jobs".

  1. If needed, pause the server by choosing Pause from the Server menu.

  2. Choose General Settings from the Setup menu.

  3. On the Log tab, complete log file settings.

  4. Activate the server by choosing Activate from the Server menu.

6.2.4 Running Recognition Server as a Service

Also see "Guidelines For Running Servers as Services".

  1. If needed, pause the server by choosing Pause from the Server menu.

  2. Choose General Settings from the Setup menu.

  3. On the Login tab, specify unattended login options.

    See "Setting Up Unattended Login".

  4. On the Services tab, specify the number of seconds (30-900) to wait for the service to shut down normally. Click OK.

  5. Open the Services applet from Administrative Tools in the Control Panel.

  6. Select the Oracle Document Capture Commit Service, right-click and choose Properties.

  7. On the General tab, change the Startup Type to Automatic.

  8. On the Properties Log On tab, configure a logon account for a user with rights to access network resources.

    This is needed only if the service will access network resources, such as sending emails on error conditions or committing to a network location.

6.3 Working With Batch Jobs

This section covers these topics:


Note:

Changes you make to a selected batch job affect all scheduled events that use the batch job.

6.3.1 Adding Batch Jobs

  1. If needed, pause the server by choosing Pause from the Server menu.

  2. Choose Batch Jobs from the Setup menu.

  3. Click New.

    A default batch job name of <Batch Job 1> displays in the Batch Jobs and Batch Job Name fields.

  4. In the Batch Job Name field, enter a new name.

  5. Select settings on the General and Processing tabs.

  6. On the Bar Code Recognition tab, identify the bar code types (symbologies) you want the batch job to detect.

    You can also detect patch codes.

  7. On the Bar Codes tab, add bar code definitions.

    See "Adding Bar Code Definitions".

  8. On the Fields tab, set bar codes or other values to autopopulate Capture index fields.

  9. On the Database Lookup tab, optionally configure a database lookup.

    See "Using a Bar Code Value to Search a Database and Assign Index Values".

  10. To test the batch job's settings, select the Test Mode field on the General tab.

    This allows you to test bar code settings without committing or having to re-scan batches. You can examine the log file to observe server activity.

  11. Click Save to save the batch job.

6.3.2 Deleting Batch Jobs

Follow these steps to delete batch jobs that are no longer used.

  1. If needed, pause the server by choosing Pause from the Server menu.

  2. Choose Batch Jobs from the Setup menu.

    The Batch Job dialog box is displayed.

  3. In the Batch Jobs dialog box, select the batch job you want to delete from the Batch Jobs field.

  4. Click Delete to remove the batch job, then confirm the deletion.

6.3.3 Adding Bar Code Definitions

A bar code definition identifies a bar code by its characteristics, such as length in characters. As bar codes are recognized, they are assigned to a bar code definition based on their data characteristics.

  1. On the Bar Codes tab of the Batch Job Settings screen, click the tab's New button (not the screen's New button).

  2. In the Description field, type a name for the bar code definition (for reference only).

  3. In the Validation Rule field, specify how Recognition Server should validate the bar code: by its length, using a mask, or from a pick-list created in Capture Administration.

    After you select a rule, additional value field are displayed (Length for length-type validation, Mask for mask-type validation and pick-list fields for pick-list validation).

  4. In the value field, specify validation values for the selected type.

    If specifying an input mask, enter a mask that describes the bar code value in the Mask field displayed. A recognized bar code will be assigned to this bar code definition if the value meets the requirements of the mask you specify. Available mask characters are listed in Table 9-1.


    Note:

    Be sure not to set up bar codes that conflict, such as two bar codes with the same length in characters. If necessary, consider using a macro to use business logic to assign bar codes.

  5. Click the tab's Save button.

6.3.4 Using a Bar Code Value to Search a Database and Assign Index Values

Follow these steps to use a database lookup previously created in Capture Administration in a Recognition Server batch job.

  1. Create the database lookup profile in Capture Administration.

    See "Adding a Database Lookup".

  2. On the Bar Codes tab, add a bar code definition.

    See "Adding Bar Code Definitions".

  3. On the Database Lookup tab, choose Bar Code in the Using field.

  4. In the Description field, select the bar code definition you created in step 2.

  5. In the Database Lookup Profile field, select the database lookup profile you created in step 1.

  6. In the Database Search Field, select a search field from those defined in the database lookup profile.

    When the batch job runs, Recognition Server will search this field for a value that matches the bar code value. If a match is found, it will populate the other fields.

  7. In the Database Lookup tab's lower portion, select other search options.

  8. Test the database lookup.

    Schedule and activate the batch job, then view its results in Index. Ensure that the specified index fields were populated correctly.

6.4 Scheduling Processing

This section covers the following topics:

6.4.1 Adding an Event

  1. If needed, pause the server by choosing Pause from the Server menu.

  2. Choose Schedule from the Server menu.

  3. Click Schedule Event.

  4. In the Event field, select the batch job or file cabinet you want the event to process.

    You can choose a previously added batch job, a file cabinet, or all file cabinets.

  5. In the Frequency field, select how often you want the job processed.

  6. If you selected a frequency of Once, Every Day, or Every Week, specify frequency details.

  7. Click OK, then Close.

  8. Activate the Recognition Server by choosing Activate from the Server menu.

  9. Once processing begins, view statistics and error log messages in the Recognition Server main screen.

6.4.2 Deleting Events

Follow these steps to stop an event from processing.

  1. If needed, pause the server by choosing Pause from the Server menu.

  2. Choose Schedule from the Server menu.

  3. Select the event you want to delete, click Remove Event, and confirm the deletion.

6.5 Maintaining Recognition Server

This section covers these topics:

Recognition Server audits certain activities and saves the information in the ecAudit table of the Capture batch database. For more information about audit activities and tables, see "Auditing in Oracle Document Capture".

6.5.1 Deleting Old Log Files

By default, Recognition Server creates log files daily that track its activities. Follow these steps to schedule clearing out old log files using the predefined Delete Old Log Files event.

  1. If needed, pause the server by choosing Pause from the Server menu.

  2. Choose General Settings from the Setup menu and click the Error Log tab.

  3. Select the Delete Old Log Files field.

  4. In the Days to Retain Log Files field, enter the number of days you want to keep log files. Click OK.

  5. Choose Schedule from the Server menu.

  6. Click Schedule Event.

  7. In the Event field, choose Delete Old Log Files.

  8. In the Event Properties fields, select how often you want to delete old log files.

  9. Click OK, then Close.

6.5.2 Shutting Down and Restarting Recognition Server

Follow these steps to schedule shutting down Recognition Server using the predefined Shut Down event.

  1. If needed, pause the server by choosing Pause from the Server menu.

  2. Choose Schedule from the Server menu.

  3. Click Schedule Event.

  4. In the Event field, choose Shut Down.

  5. Click OK, then Close.

As an option, use the Microsoft Task Scheduler to restart Recognition Server. To prevent Recognition Server from displaying a login screen, make sure unattended login settings are selected, as described in "Setting Up Unattended Login".