Skip Headers
Oracle® Fusion Middleware Managing Oracle WebCenter Capture
11g Release 1 (11.1.1)

Part Number E37898-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

5 Managing Import Processing

Capture's Import Processor provides automated bulk importing of documents (image and non-image) into a Capture workspace from email, network folders, or list files. This chapter describes how you configure and manage import jobs and their processing.

This chapter includes the following sections:

5.1 Introduction to Import Processing

This section covers the following topics:

5.1.1 Key Import Processor Job Settings

You can apply the Import Processor's automated import of images and other electronic documents into Capture to such applications as:

  • Multi-function devices

  • Images scanned using third-party software

  • Documents sent as email attachments

  • Images referenced in a list file that were scanned by a service bureau

Depending on the files to be imported, you create import processor jobs for the following import sources:

  • Email Source: Import Processor imports files attached to incoming email messages into Capture. It can also import the email body and entire email message.

  • Folder Source: Import Processor monitors an import folder and imports all files it finds with a specified file mask.

  • List File Source: Import Processor monitors an import folder and reads a list (text) file containing records that identify each file to import, and optionally, metadata values to be assigned to the file or values to be matched against a database.

5.1.2 Important Points About Import Processing

  • Unlike the other batch processors that process batches that are queued, the Import Processor polls at a specified frequency (ranging from every 30 seconds to once a day), in which it searches the specified source for files to import and if found begins processing them.

  • You configure settings specific to the selected source (email, folder, or list file) on the Import Source Settings train stop. For example:

    • For a folder import job, you identify the folder and file types to import, as shown in Figure 5-1.

    • For a list file job, you identify the folder and list file to be read.

    • For an email source, you specify email accounts to monitor and email messages and/or attachments to import.

  • The Import Processor supports processing of all import sources across multiple threads on a server as well as multiple servers in a cluster.

  • You can customize import processor behavior by incorporating JavaScripts. See Section 5.11.

Figure 5-1 Selecting General Settings, including an Import Source, for an Import Processor Job

Description of Figure 5-1 follows
Description of "Figure 5-1 Selecting General Settings, including an Import Source, for an Import Processor Job"

5.2 Adding, Copying, or Editing an Import Processor Job

Follow these guidelines regarding editing import processor jobs:

To add, copy, or edit an import processor job:

  1. In a selected workspace, click the Capture tab.

  2. In the Import Processor Jobs table, click the Add button or select a job and click the Edit button.

    You can also copy an import processor job by selecting a job, clicking the Copy button, and entering a new name when prompted. Copying a job allows you to quickly duplicate and modify it.

  3. Select settings on the General Settings train stop.

    1. Enter a name in the Import Job Name field and a prefix in the Batch Prefix field. Imported batches are named using this prefix, followed by a number that increments with each new batch.

    2. In the Import Source field, specify a source for imported files: Email Source, Folder Source, or List File Source.

      The source you select determines the settings shown on the Import Source Settings train stop.

    3. In the Import Frequency field, specify the time interval at which the import processor job checks for files to import. You can choose every 30 seconds, every 1, 5, 15, or 30 minutes, every 1 hour, or every day. If you specify every day, specify a time in the Time Hr and Min fields that display.

    4. Complete other settings on the train stop, such as specifying a default batch status or priority to assign to batches when they are created.

  4. On the Image Settings train stop, complete settings relating to how imported files are stored and validated.

    1. In the Image Down-Sample field, specify how to convert images, by retaining their image format (None), converting color to grayscale (Down-sample color to 8 bit grayscale), or converting either to black and white (Down-sample color or grayscale to black and white).

    2. In the JPEG Image Quality field, specify a value between 0 and 99, where 99 is the highest quality and 50 is the default setting.

    3. In the If Image Validation Fails field, specify an action if an image page fails validation: Delete the batch or Skip the file.

  5. On the Document Profile train stop, complete settings related to assigning metadata to imported documents. See Section 5.8.

  6. On the Import Source Settings train stop, configure source-specific settings.

  7. On the Database Lookup train stop, optionally configure a database lookup to assign metadata values from a database during import. See Section 5.9.

  8. On the Post-Processing train stop, specify what happens after import processing completes, depending on whether system errors were encountered.

    See Section 5.10.

  9. Review settings on the Import Job Summary train stop and click Submit.

  10. Test the import processor job you created.

    Set the frequency to a minute and monitor the folder, list file, or email account to view processing activity.

5.3 Deleting an Import Processor Job

When you delete an import job, the Import Processor no longer monitors for files to import at the job's specified frequency.

To delete an import job:

  1. In a selected workspace, select the Capture tab.

  2. In the Import Processor Jobs table, select a job to delete and click the Delete button.

    (To deactivate rather than delete a job, select it and click the Toggle Online/Offline button.)

  3. When prompted, click Yes to confirm the deletion.

5.4 Activating or Deactivating Import Jobs

If online, import jobs run at the interval specified in the Import Frequency field on the job's General Settings train stop. You can temporarily stop the job from running (take it offline) or change a deactivated job to run again.

Follow these steps to change an import processor job to online or offline:

  1. On the Capture tab, select a job in the Import Processor Jobs table. Notice that the Status column displays Online or Offline for each job.

  2. Click the Toggle Online/Offline button to either activate the job or deactivate it.

    Note that you can also deactivate or activate an import processor job by selecting or deselecting the Online field on the General Settings train stop.

5.5 Configuring Email Message and Attachment Importing

With an email import job, the Import Processor imports files attached to incoming email messages into Capture along with email message elements, such as subject and body text. Each imported email message becomes a batch, with email elements such as attachments, message body, or entire email message created as separate documents within the batch. Note that message body text becomes a non-image file.

To configure email import processor job settings:

  1. Follow the steps in Section 5.2 to add, edit, or copy an import processor job, selecting Email Source in the Import Source field on the General Settings train stop.

  2. Select the Import Source Settings train stop to configure email import configuration on each tab.

    Figure 5-2 Choosing Email Source Settings on the Import Source Settings Train Stop

    Description of Figure 5-2 follows
    Description of "Figure 5-2 Choosing Email Source Settings on the Import Source Settings Train Stop"

  3. On the Email Accounts tab, configure the email server the import processor job will connect to by defining its DNS name or IP address, port, and security. If using SSL (Secure Sockets Layer) or TLS (Transport Layer Security), the certificate for the email server must be in the application server (WebLogic) keystore.

    Then configure the specific email accounts that the job will check for messages. In the Email Accounts to Process table, click the Add button. In the Add/Edit Email Account window, enter an email address and password to provide the job access to the email account. Include additional email accounts if needed.

  4. On the Message Filters tab, specify where and how to search for email messages and/or attachments.

    1. In the Folders to Process field, enter one or more folders to search in the specified email accounts. The default value is the server's inbox. To specify multiple folders, separate them with a ; (semi-colon). To specify subfolders, include a path delimiter applicable for the mail server, such as a / (forward slash), as in folder/subfolder.

    2. In the Message Filters table, select the Enabled field for each email element to search, then enter characters to find in the Field Contains field.

      For example, to search for emails whose subject or message body contains the word payment, you would select Enabled for both search fields, include payment in each Field Contains entry, and select the Or search operator.

    3. In the Search Operator field, select the search operator to use for the specified message filters: And (default) imports only if all search criteria match, while Or imports if any search criteria matches.

  5. On the Processing tab, specify how to process the email messages and their attachments. For example, specify information to include, and priority to assign to batches, based on email priority.

    1. Under Email Message Options, specify whether to import the message body file, and if yes, select an import format (text or EML) and whether to include it when no attachments are present. Lastly, specify whether to import the entire email message (including attachments) as an EML file.

    2. Specify attachment files to include or exclude based on their file masks. For example, you might include all PDF files (*.pdf) or exclude all GIF files (*.gif).

    3. Under Document Ordering, specify the order in which the elements (for example, message body and attachments) from an email message are ordered as documents in imported batches.

    4. Under Include in Batch Note, select message elements to include in a note attached to each imported batch.

    5. Under Batch Priority, optionally assign a priority (low, normal, or high) to each new batch based on its email priority. For example, enter 8 in the High field to assign high priority emails a batch priority of 8 in Capture. Note that emails not assigned a priority are considered normal priority.

  6. On the Post-Processing tab, specify what happens to email messages after successful or failed import. You can delete messages, move them to a specified folder, or in the case of failed import, prevent messages from being deleted. For example, you might prevent successfully imported emails from being imported again if the job is run regularly by moving them to a specified folder, but retain messages that failed import.

  7. Complete other import processor job train stops as described in Section 5.2.

  8. Test the email import job.

    When the job is activated at the specified frequency, the Import Processor checks the specified email accounts for messages and searches folders for matching emails. If found, the Import Processor processes the attachments, optionally populates metadata fields with email metadata, and optionally deletes successfully imported messages or moves them to a folder.

5.6 Configuring File Importing From a Folder

With a folder import job, the Import Processor monitors an import folder, and imports all files it finds with a specified file mask.

To configure folder import processor job settings:

  1. Follow the steps in Section 5.2 to add, edit, or copy an import processor job, selecting Folder Source in the Import Source field on the General Settings train stop.

  2. Complete settings on the Import Source Settings train stop.

    1. In the Import Folder Path field, specify the folder for the Import Processor to monitor. Use a fully qualified folder path relative to the Capture server operating system.

      On Linux, you might enter: /net/abc-01/import/expenses

      On Windows, you might enter: \\abc-01\import\expenses

    2. In the File Mask(s) field, specify the type of files to import by entering an extension (*.tif or *.pdf, for example). Specify *.* to import all files. Separate masks with a semi-colon (;) character.

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

      Figure 5-3 Choosing Folder Settings on the Import Source Settings Train Stop

      Description of Figure 5-3 follows
      Description of "Figure 5-3 Choosing Folder Settings on the Import Source Settings Train Stop"

    4. In the Create a New Batch field, specify whether to create a new batch with each file imported or with each folder imported.

    5. In the Ready File field, optionally enter a file name that must exist in the folder (and each subfolder, if applicable) before processing the folder. This option delays the processing of a folder until the ready file appears. When processing is completed, the ready file is deleted.

    6. In the File Processing Order fields, specify the order in which files in the import folder are processed, by specifying their primary and secondary sort type and order. You can specify import order based on sort types of None (no sort order), File Name, File Extension, or File Modified Date, and specify a sort order of Ascending or Descending.

    7. In the File Post-Processing fields, specify how to change files after import so they are not imported again if the job is run regularly. For example, you can delete files, change their extension, and add a prefix to them. You can also perform cleanup on processed subfolders by selecting the Delete processed subfolder if empty field.

  3. Complete other import processor job train stops as described in Section 5.2.

  4. Test the folder import job.

    When the job is activated at the specified frequency, the Import Processor checks the folder for files matching the file mask(s). If it finds matches, it imports the files and creates new batches, populates metadata fields, and changes the files as specified.

5.7 Configuring List File Importing

With a list file import job, the Import Processor monitors an import folder for matching list files, and imports the document files and metadata values identified in the list file.

A list file job can also search a database for matching list file values in order to populate metadata fields. See Section 5.9.

To configure list file import processor job settings:

  1. Generate a list file.

    A list file is an ASCII text file containing records of delimited data that identify the names of files to be imported and their location. Each record may also include metadata values to assign to the document or to match against a database file.

  2. Follow the steps in Section 5.2 to add, edit, or copy an import processor job, selecting List File Source in the Import Source field on the General Settings train stop.

  3. On the General Settings train stop, complete the Default Locale, Encoding, and Default Date Format fields.

    These fields enable the Import Processor to correctly read list files based on your locale.

  4. Complete settings on the Import Source Settings train stop.

    1. In the Import Folder Path field, specify the folder for the Import Processor to monitor. Use a fully qualified folder path relative to the Capture server operating system.

      On Linux, you might enter: /net/abc-01/import/expenses

      On Windows, you might enter: \\abc-01\import\expenses

    2. In the File Mask(s) field, specify the list files to import by entering their extension (*.LST, for example). Separate masks with a semi-colon (;) character.

      To monitor and import list files from subfolders within the specified folder, select the Process subfolders field. Import Processor always creates a new batch for each subfolder processed.

    3. From the Create a New Batch options, specify whether to create a new batch for each file (for example, for each multiple page TIFF image file) or folder imported.

    4. In the Field Delimiter field, specify how fields are delimited in the list file. Use a delimiter that will not be used in the list file metadata.

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

    5. In the Maximum Fields Per Document field, specify a maximum number of fields in the list file to map to metadata fields.

    6. In the Document File Field Position field, enter the list file field position of document file names and locations. For example, enter 1 if the first field in each record in the list file identifies a document name and path.

      Note:

      If the specified document file field position does not contain a path to the file to be imported, it is assumed that the file is located in the same folder as the list file being processed.

    7. In the List File Post-Processing fields, specify how to change list files after import so they are not imported again if the job is run regularly. For example, you can delete them, change their extension, or add a prefix to them.

    8. In the Document File Post-Processing fields, specify if you want to delete document files from their specified location after successful import.

      Figure 5-4 Choosing List File Settings on the Import Source Settings Train Stop

      Description of Figure 5-4 follows
      Description of "Figure 5-4 Choosing List File Settings on the Import Source Settings Train Stop"

  5. On the Document Profile train stop, map Capture metadata fields to list file values, identifying field position in the list file using the Field 1 - Field n metadata attributes. You can also map system level fields, as described in Section 5.8.

    For example, to map a Customer ID metadata field with the first field in each record in the list file, you would select the Customer ID field in the Metadata Field Mappings table, click the Edit button, and select Field 1 in the Metadata Attributes field of the Metadata Field Mappings window.

    Figure 5-5 Mapping Metadata Fields to List File Fields

    Description of Figure 5-5 follows
    Description of "Figure 5-5 Mapping Metadata Fields to List File Fields"

  6. Complete other import processor job train stops as described in Section 5.2.

  7. Test the list file import job.

    When the job is activated at the specified frequency, the Import Processor checks the folder for list files matching the specified file mask(s), imports the document files identified in the list file, optionally populates metadata fields with list file data and optionally deletes or renames the list file.

5.8 Configuring Metadata Assignment During Import

Use the Document Profile train stop to configure how import job values are mapped to Capture metadata fields during import processing.

  1. In an import processor job, select the Document Profile train stop, as shown in Figure 5-6.

  2. In the Default Document Profile field, specify a document profile to assign to imported documents. The selected profile classifies the document. For example, if users open the batch in the client, this document profile is selected.

    Figure 5-6 Configuring Metadata Assignment for an Import Processor Job

    Description of Figure 5-6 follows
    Description of "Figure 5-6 Configuring Metadata Assignment for an Import Processor Job"

  3. In the Metadata Field Mappings table, map Capture metadata fields to metadata values specific to the selected import source.

    In the Metadata Field column, select a Capture field to populate, and click the Edit button. Note that all Capture metadata fields defined for the workspace are available for mapping. A Capture metadata field does not need to be included in the selected default document profile to be populated.

  4. Complete settings in the Metadata Field Mappings window.

    1. Select a metadata value for the import source in the Metadata Attributes field. To populate with a default value, select Default value in this field, then specify the value in the Default Value field. If needed, select a date format in the Date Format field. (The Date Format field is available only for the List File source and only when mapped to a list file position, Field 1 - Field n. If a date format is not specified, the default date format specified on the General Settings tab is used.)

    2. In a list file import job, select from list file, document, or field-related attributes, listed in Table 5-1. To map values contained in the list file, identify their field position using the field attributes (Field 1, Field 2, and so on.) The number of field attributes displayed depends on the number specified in the Maximum Fields Per Document field on the list file's Import Source Settings train stop.

      Table 5-1 System Metadata Attributes for List File Import Jobs

      System Attribute Value for example list file being imported (/import/expenses/20120426/Customer1.LST)

      List File Name

      Customer1.lst

      List File Base File Name

      Customer1

      List File Extension

      LST

      List File Folder Path

      /import/expenses/20120426

      List File Folder Name

      20120426

      List File Full File Path

      /import/expenses/20120426/Customer1.LST

      Document File Name

      Customer1.pdf

      Document Base File Name

      Customer1

      Document File Extension

      pdf

      Document Folder Path

      /import/expenses/20120426

      Document Folder Name

      20120426

      Document Full File Path

      /import/expenses/20120426/Customer1.pdf

      Document File Modified Date/Time

      File modified date/time - system value


    3. In a folder import job, select from folder, file, or path-related attributes, listed in Table 5-2.

      Table 5-2 System Metadata Attributes for Folder Import Jobs

      System Attribute Value for example path for file being imported (/import/expenses/20120426/Customer1.pdf)

      File Name

      Customer1.pdf

      Base File name

      Customer1

      File Extension

      Pdf

      Folder Path

      /import/expenses/20120426

      Folder Name

      20120426

      Full File Path

      /import/expenses/20120426/Customer1.pdf

      File Modified Date/Time

      File modified date/time - system value


    4. In an email import job, select from email message-related attributes, listed in Table 5-3.

      Table 5-3 System Metadata Attributes for Email Import Jobs

      System Attribute Description

      From Name

      Name alias of From address

      From Address

      Sender's email address

      Reply To Name

      Reply To Name for the message

      Reply To Address

      Reply To Address for the message

      Recipient Names

      Collection of recipient names for the message

      Recipient Addresses

      Collection of recipient address for the message

      Folder

      Folder name from which the message was obtained

      Received Date

      Date and time message was received

      Sent Date

      Date and time message was originally sent

      Subject

      Subject of the message

      Email Importance

      Low, normal and high priority value of the message

      MessageId

      Unique ID of the message


    5. In any import job, select from common system attributes, listed in Table 5-4.

      Table 5-4 Common System Metadata Attributes for Import Jobs

      System Attribute Description

      Import Date/Time

      Date and time at which batch was imported

      Import Job Name

      Name assigned to the import processor job

      Default Value

      Default value assigned as specified

      Capture Server's Host Name

      Host name assigned to the Capture server


  5. Click OK. Map other metadata fields in the Metadata Field Mappings table as needed.

5.9 Assigning Metadata Values from a Database Lookup During Import

Follow these steps to use a database lookup profile in an import job. Using a database lookup allows the Import Processor, in addition to importing from an email, folder, or list file source, to also search a specified database for a record that matches an identifying value and if found, populate other metadata fields from the database.

To perform a database search during an import job, the Import Processor needs a value to search for in a specified database record. For example:

To configure a database lookup for an import processor job:

  1. On the Metadata tab, create the database lookup profile, as described in Section 3.8.

  2. On the Capture tab, add or edit an import processor job, as described in Section 5.2.

  3. On the import job's Document Profile train stop, configure mapping for the search field you defined in the database lookup. See Section 5.8.

    For example, for a list file import job, you would map the database lookup's search field by selecting the metadata field in the Metadata Field Mappings table, clicking the Edit button, and selecting the field position of the list file value to search.

  4. On the import job's Database Lookup train stop, configure the lookup.

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

    2. In the Database Search Field field, select the Capture field on which to search.

    3. In the When more than one record is found field, select whether to use the first record found or skip selecting a record.

  5. Run the Import Processor job and test the database lookup.

    When the job is online and run at its frequency, the Import Processor imports as specified, reads or acquires the specified value, searches the database field for a matching value and if found, populates other metadata fields from the database table.

5.10 Configuring Post-Processing

You use post-processing settings to specify what happens after import processing completes a batch. To configure post-processing for an import processor job:

  1. When adding or editing a job (see Section 5.2), select the Post-Processing train stop.

  2. In the Batch Processor field, select the next step for batches after they are created and import processing is complete.

  3. In the Batch Processor Job field, select a recognition or document conversion job to run, if you selected Recognition Processor or Document Conversion Processor in the previous step.

  4. Click Submit to save the client profile.

5.11 Customizing Import Processing Using Scripts

To customize import processor behavior, incorporate JavaScripts. For example, you might use scripts to skip the importing of certain image files or batches or to add document-level metadata values during importing.

To use a script in an import processor job:

  1. From a developer, obtain an import processor JavaScript file.

    Information on writing import processor scripts is provided in Oracle Fusion Middleware Developing Scripts for Oracle WebCenter Capture.

  2. On the workspace's Advanced tab, import the script, specifying Import Processor as its script type, and identifying the script file. For more information, see Section 3.11.

  3. On the Capture tab, select the import processor job and click the Edit button.

  4. In the Script field on the General Settings train stop, select the import processor script you imported.

  5. Test the results of the added import script.

    In the Import Frequency field, specify a short time interval, then click Submit to save the job. Monitor the specified import source and test the import results.