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
 

7 Administering Import Server

This section covers the following topics:

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

7.1 Starting, Pausing and Activating the Import Server

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

    Import Server starts in an active state if there are scheduled jobs. However, Import 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.

7.2 Configuring the Castelle FaxPress Provider

If importing faxes from a Castelle FaxPress appliance, follow these steps to configure the Castelle FaxPress Provider to work with Import Server. For more information about the Castelle FaxPress product, see www.castelle.com.

  1. Set up the FaxPress hardware.

  2. Install and configure the server software for the appliance.

  3. Install the FaxPress client software on the machine that will be running Import Server.

  4. Run the client software, log in as the administrator, and verify that you can view the installed server.

    See the documentation provided with your FaxPress hardware for more information.

  5. Using the client software, configure the incoming fax line you want the Import Server FaxPress provider to work with.

    1. Using the FaxPress client software, you can configure a fax line on the server so that incoming faxes are automatically routed to the Inbox of a specific user.

    2. Configure one of the lines so that it will route faxes to the same user ID that an Import Server FaxPress job will login as. (See "Importing Faxes From a Castelle FaxPress Network Appliance".)

    3. Make sure that the user ID is used exclusively by the Import Server FaxPress Provider. That way, incoming faxes meant to be imported into Capture will not be accessed by other users.

7.3 Configuring Import Server

This section covers the following topics:

7.3.1 Setting Up Unattended Login

Follow these steps to specify a login user name and password so Import 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.

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

7.3.3 Setting Up File Associations

Follow these steps to automatically change non-image files' extensions before they are printed by the Import Server and converted to images. For more information, see "How Import Server Converts Non-Images to Images".

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

  2. Choose General Settings from the Setup menu.

  3. On the File Associations tab, click Add.

  4. In the Map File Extension dialog box, enter new and old extensions (for example, .htm to .doc). Click OK.

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

7.3.4 Setting Up Activity Logging

Follow these steps to specify how Import 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 "Working With 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 File tab, complete log file settings.

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

7.3.5 Running Import 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 Import 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.

7.4 Working With Batch Jobs

This section covers the following topics:

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

    The Batch Settings screen is displayed.

  3. From the list of installed import providers in the left pane, select the folder for the job type you want to add. Click Add Job.

    A default batch job name of <JOB 1> displays within the provider folder. A red slash mark across the job's icon indicates that it is not scheduled yet.

  4. Rename the batch job by right-clicking it, choosing Rename and entering a new name.

  5. Select settings on the General tab.

  6. Select settings on the Processing tab.

  7. On the Image Output tab, specify an output format for image and non-image files.

  8. Select settings on the provider-specific tab.

  9. Click Save, then Close.

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

  3. In the left pane of the Batch Job Settings dialog box, open the provider folder and select the batch job you want to delete.

  4. Click Remove Job, then confirm the deletion.

7.4.3 Importing Faxes From a Castelle FaxPress Network Appliance

Follow these steps to automatically import faxes into Capture from a Castelle FaxPress network appliance.

  1. Configure the Castelle FaxPress Provider to work with Import Server.

    See "Configuring the Castelle FaxPress Provider".

  2. In the Batch Job Settings screen, add a FaxPress batch job, and select settings on the General, Processing and Image Output tabs.

    See "Adding Batch Jobs".

  3. Specify settings on the FaxPress Provider Settings tab.

    See "Batch Job Settings, FaxPress Provider Settings Tab".

  4. Schedule the job and activate Import Server.

    • When the job is activated, the FaxPress Provider logs into the specified server.

    • It checks the user's Inbox for faxes. If a fax is found, it imports the fax starting with the first page of the fax, unless directed to discard the first page when configured.

    • After import, the fax is deleted from the user's Inbox.

    • A batch note is generated for the new batch in Capture that contains the date on which the fax was received and the Remote Terminal ID of the machine that sent the fax.

7.4.4 Importing Using a Custom Provider

Follow these steps to create a custom provider macro and select it for use in importing files into Capture.

  1. Choose Macro Manager from the Setup menu.

  2. In the Category field of the Macro Manager, select Custom Provider.

  3. Click New and create a new macro.

    See the Developer's Guide for Oracle Document Capture for information about Custom Provider events for Import Server macros.

  4. In the Batch Job Settings screen, add a Custom Provider batch job, and select settings on the General, Processing and Image Output tabs.

    See "Adding Batch Jobs".

  5. In the Provider Macro field on the General tab, select the custom macro you created.

  6. Schedule the job and activate Import Server.

7.4.5 Importing Email Messages and Attachments

Follow these steps to set up an email batch job. Import Server imports files attached to incoming email messages into Capture. In addition, it can convert each email message to an image.

  1. In the Batch Job Settings screen, add an Email Provider batch job, and select settings on the General, Processing and Image Output tabs.

    See "Adding Batch Jobs".

  2. Choose the Email Provider Settings tab.

  3. On the Email Accounts subtab, configure the email accounts that Import Server will check for messages when the batch job is run.

  4. On the Email Filters subtab, set up filters that identify the emails and attachments you want Import Server to search for and import.

  5. On the Processing subtab, specify the email contents you want to include in a batch note, the priority to assign, and whether to convert the email body to an image.

  6. On the Field Mappings subtab, map key email values to be assigned to Capture index fields.

  7. On the Post-Processing subtab, specify what happens to email messages after importing, such as deleting them but forwarding those that failed import.

  8. Schedule the job and activate Import Server.

    When the job is activated, the provider checks the specified email accounts for messages, looks for emails and attachments containing specified text or particular file extensions, processes the attachments, populates index fields with email data and deletes (and optionally forwards) the messages.

7.4.6 Importing Files From an FTP Server

Follow these steps to set up an FTP batch job. Import Server connects to an FTP Server and imports images or other documents (such as Microsoft Word and PDF) into Capture from a specified folder.

  1. In the Batch Job Settings screen, add an FTP Provider job, and select settings on the General, Processing and Image Output tabs.

    See "Adding Batch Jobs".

  2. In the Connection Settings fields on the FTP Provider Settings tab, specify the FTP server's host name, and a user ID and password with which to connect to the server.

  3. In the Import Folder field, specify the folder on the FTP server from which to download and import documents.

  4. In the File Mask field, specify the type of files to import by entering an extension (*.TIF, for example). Enter *.* to import all files.

  5. Select additional FTP settings on the FTP Provider Settings tab.

  6. Schedule the job and activate Import Server.

    When the job is activated, the provider connects to the specified FTP Server, looks for images and documents and processes them, importing each page as an image.

7.4.7 Importing Files From a Folder

Follow these steps to set up a folder batch job. Import Server monitors an import folder, and imports all files it finds with a specified file mask.

  1. In the Batch Job Settings screen, add a Folder/List File batch job, and select settings on the General, Processing and Image Output tabs.

    See "Adding Batch Jobs".

  2. On the Folder/List File Provider Settings tab, select the Import from folder radio button.

  3. In the Import Folder field, specify the folder you want Import Server to monitor.

    You can use folders that are representative of mapped drive letters or UNC (Universal Naming Convention) paths.

    If you want Import Server to monitor and import files subfolders within this folder, select the Include subfolders field. Import Server creates a new batch for each subfolder processed.

  4. In the File Mask field, specify the type of files to import by entering an extension (*.TIF, for example). Specify *.* to import all files.

  5. Select additional folder settings on the Folder/List File Provider Settings tab.

  6. Schedule the job and activate Import Server.

7.4.8 Importing Files From a Folder and Values From a List File

Follow these steps to set up a list file batch job. Like a folder job, a list file job monitors an import folder, importing files it finds. In addition, it reads a list (text) file containing records that identify each image to import.

A list file job can also search a database for matching list file values in order to populate index fields. See "Assigning Index Values From a Database During Import"

  1. Generate a list file.

    A list file contains records of delimited data, including the names of files to be imported. A list file may also include index values to pass into a Capture batch or values to be matched against a database file.

  2. In the Batch Job Settings screen, add a Folder/List File batch job, and select settings on the General, Processing and Image Output tabs.

    See "Adding Batch Jobs".

  3. On the Folder/List File Provider Settings tab, select the Import from list file radio button.

  4. In the Import Folder field, specify the folder you want Import Server to monitor.

    You can use folders that are representative of mapped drive letters or UNC (Universal Naming Convention) paths.

  5. In the File Mask field, specify the type of files to import by entering an extension (*.TIF, for example). Specify *.* to import all files.

  6. In the Field Delimiter field, specify how fields are delimited in the list file.

    For example, use | (pipe), , (comma) or ~ (tilde).

  7. In the List file format area, identify how fields are formatted in the list file, by moving available fields to the Selected Fields field and placing them in the same order as they reside in the list file.

    Use the left and right arrows to move fields to the Selected Fields field. Use the up and down arrows to change their order in the Selected Fields field.

    You can include system-defined fields (enclosed in brackets) and index fields from the selected Capture file cabinet. You must include the [Image Filename] field, which identifies the name and path of files to be imported. Include the [Skip] field to skip reading a field in the list file.

  8. Select additional list file settings on the Folder/List File Provider Settings tab.

  9. Schedule the job and activate Import Server.


Note:

If the list file contains a single line and no image, Import Server processes the batch, but does not create an ERR file for the list file.

7.4.9 Assigning Index Values From a Database During Import

Follow these steps to use a database lookup profile in an Import Server list file batch job. Using a database lookup allows Import Server to not only import images from a folder and read identifying values in the list file, but also to search the database for a record that matches the list file value, and if found, populate other index fields from the database.

  1. Create the database lookup profile in Capture Administration.

    See "Adding a Database Lookup".

  2. In the Import Server's Batch Job Settings screen, add a list file provider batch job.

    See "Adding Batch Jobs".

  3. On the batch job's Processing tab, select the database lookup profile you created in step 1 in the Profile Name field.

  4. From the Search Field option, choose the database field you want to search.

  5. In the Document Type options, specify if the batch job will import multiple or single page documents.

  6. On the Folder/List File Provider Settings tab, configure the list file settings.

    Be sure to include the Capture field to be matched with the database search field you selected in step 4.

  7. Schedule the job, activate Import Server and test the database lookup.

    When the job is activated, the provider imports the image whose path is specified in the list file. It then reads a specified value in the list file, searches the database field for a matching value and if found, populates other index fields from the database table.

7.5 Scheduling Processing

This section covers the following topics:

7.5.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 Import Server by choosing Activate from the Server menu.

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

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

7.6 Maintaining Import Server

This section covers these topics:

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

7.6.1 Deleting Old Log Files

By default, Import 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.

7.6.2 Shutting Down and Restarting Import Server

Follow these steps to schedule shutting down Import 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 Import Server. To prevent Import Server from displaying a login screen, make sure unattended login settings are selected, as described in "Setting Up Unattended Login".