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
 

17 Working With Commit Profiles

This section covers the following topics:

17.1 Adding a Commit Profile

Follow these steps to add a commit profile for a file cabinet.

  1. In the Capture screen, choose File Cabinets from the Admin menu. Select the file cabinet to which you want to add a commit profile.

  2. From the file cabinet's tree structure, select Commit Profiles.

  3. Click the New (sun) button. Enter a name and click OK.

  4. In the Commit Driver field, specify the method by which this profile will commit documents. Click Configure and configure driver settings.

    See settings for the selected driver:

  5. In the Document Output Format field, specify the format in which you want documents committed. Click Configure and configure output format settings.

  6. In the If document file already exists field, specify how the commit profile will handle duplicate documents.

  7. In the left pane, click Commit Profiles and order and activate profiles.

    See "Activating and Ordering Commit Profiles".

17.2 Deleting Commit Profiles

Follow these steps to delete a commit profile.

  1. In the Capture screen, choose File Cabinets from the Admin menu and select a file cabinet.

  2. From the file cabinet's tree structure, select Commit Profiles.

  3. Select the commit profile you want to delete and click the Delete button in the toolbar. Confirm the deletion.

17.3 Configuring the Language for Full Text OCR Output

This task is required for Full Text OCR output only. Set the language to be used for creating OCR text files during commit, in each commit profile.

  1. In Capture Administration, select a commit profile.

  2. Click Configure next to the Document Output Format field.

  3. In the Export Settings screen, select the Perform Full Text OCR field.

  4. In the OCR Language field, select the language in which you want the OCR text file created.

  5. In the Code Page field, select the character set to be used for storing OCR text, if needed.

  6. Repeat these steps for each commit profile set for full text OCR output.

17.4 Activating and Ordering Commit Profiles

Follow these steps to activate and order commit profile processing.

  1. In the Capture screen, choose File Cabinets from the Admin menu and select a file cabinet.

  2. From the file cabinet's tree structure, select Commit Profiles.

    The file cabinet's commit profiles are listed in the right pane. A checkmark is displayed next to active profiles.

  3. Use the up and down arrow buttons to order the commit profiles and activate or deactivate them as needed.


    Note:

    Documents in which an error is encountered remain in the batch until the error is resolved and they are committed again. When multiple profiles are used, this means that documents can be committed more than once. It is recommended that you position the commit profile most likely to fail first.

17.5 Configuring an Oracle UCM 10g Commit Profile

Follow these steps to configure a profile for committing documents to Oracle UCM. For more information, see "About the Oracle UCM 10g Commit Driver".


Note:

You can choose the following output formats when archiving documents to Oracle UCM: TIFF-Multiple Page, PDF-Image Only and PDF-Searchable. (PDF-Searchable is available for Oracle Document Capture only.)

  1. In the Capture Administration screen, create a commit profile.

    See "Adding a Commit Profile".

  2. Select Oracle UCM Commit Driver in the Commit Driver field. Click the adjacent Configure button.

    The Oracle UCM Commit Settings screen is displayed.

  3. On the Login tab, enter a user name, password, and URL to log in to UCM during commit. Click Login. The Check-In and Field Mappings tabs become available.

  4. On the Check-In tab, specify where documents will be visible in Oracle UCM, how they will be named and who can view and access them. For information about specifying Type, Security Group, and Account metadata values, see "Assigning Metadata During an Oracle UCM 10g Commit".

  5. On the Field Mappings tab, specify how you want Capture index values written to Content Server fields during commit.

17.5.1 Assigning Metadata During an Oracle UCM 10g Commit

You can assign type, security group, and account metadata values to documents in one of these ways:

17.5.1.1 Using Static Values

When you assign values in this way, documents committed using the profile are assigned the metadata values selected from those available for the specified Content Server.

  1. On the Check-In tab of the Oracle UCM Commit Settings screen, select values in the Default Type, Default Security Group, and Default Account fields.

17.5.1.2 Based on Capture Index Values

When you assign values in this way, documents committed using the profile are assigned metadata values based on Capture field values.

  1. On the Check-In tab of the Oracle UCM Commit Settings screen, select the Assign values dynamically field, then choose By Field Mappings. This adds <Account>, <Content Type>, and <Security Group> metadata mappings to the Field Mappings tab.

  2. On the Field Mappings tab, select a Capture index field for each of the metadata mappings fields.


    Note:

    If you do not map the <Account>, <Content Type>, or <Security Group> fields, the value specified in the corresponding <Default Type>, <Default Security Group>, or <Default Account> field on the Check-In tab is used.

17.5.1.3 Based on User's Pick-list Selections

When you assign values in this way, a combination of metadata values is assigned based on a user's pick-list selection. For example, if a user selects a value of Invoice from a pick-list index field, the document might be assigned a type of ACCTG, a security group of Finance, and no account value (<No Account> selected).

This configuration requires a pick-list. For more information, see "About Pick-lists".

  1. On the Check-In tab of the Oracle UCM Commit Settings screen, select the Assign values dynamically field, then choose By Index Field.

  2. In the Index Field field, select the Capture field whose pick-list value will be used to assign type, security group, and account.

  3. In the Pick-list Source field, select Capture Native Pick-list or a previously created database pick-list.

  4. In the Pick-list field, select the pick-list from those available for the source you selected.

  5. Click Add.

  6. In the Add Metadata Mappings screen that displays, select one or more field values and select options in the Type, Security Group, and Account fields.


    Note:

    The Type, Security Group, and Account fields each contain a default option (for example, <Default Type>). Select one of these default options to use the value specified in the corresponding default field on the Check-In tab (for example, Default Type field). This can simplify changing the default for many mappings by changing the default value on the Check-In tab.


    Note:

    The Account field contains a <No Account> option that you can select to skip assigning a value to the Account metadata field. (Type and Security Group are required and cannot be skipped.)

  7. Repeat steps 5 and 6 to continue mapping field values.

17.6 Configuring an Oracle UCM 11g Commit Profile

This section covers the following topics:

For more information, see "About the Oracle UCM 11g Commit Driver".

17.6.1 Configuring an Oracle UCM 11g Commit

Follow these steps to configure a profile for committing documents from Capture 10gR3 to Oracle UCM 11g.

  1. In Capture Administration, create a commit profile.

    See "Adding a Commit Profile".


    Note:

    You can choose the following output formats when archiving documents to Oracle UCM: TIFF-Multiple Page, PDF-Image Only, PDF-Searchable, and Native File. Note that PDF (Searchable) is available for Oracle Document Capture only. Native File should be used for custom applications only.

  2. Select Oracle UCM 11g Commit Driver in the Commit Driver field.


    Note:

    Be sure that 11g is displayed in the commit driver name.

  3. Click the adjacent Configure button.

    The Oracle UCM 11g Commit Settings screen is displayed.

  4. On the Login tab, enter a user name, password, and URL to log in to Oracle UCM during commit. (The user name and password are case sensitive.) Click Login. The remaining tabs become available.

  5. On the Check-In tab, specify where to make documents visible in Oracle UCM, how to name them and who can view and access them.

    For information about specifying Type, Security Group, and Account metadata values, see "Assigning Metadata During an Oracle UCM 11g Commit".

  6. On the Field Mappings tab, specify how to write Capture index values to Content Server fields during commit.

  7. On the Options tab, specify additional settings.

17.6.2 Assigning Metadata During an Oracle UCM 11g Commit

You can assign type, security group, and account metadata values to documents using one of these methods:

17.6.2.1 Using Static Values

When you assign values using this method, documents committed using the profile are assigned the metadata values selected from those available for the specified Content Server.

  1. On the Check-In tab of the Oracle UCM 11g Commit Settings Screen, select values in the Default Type, Default Security Group, and Default Account fields.

17.6.2.2 Based on Capture Index Values

When you assign values using this method, documents committed using the profile are assigned metadata values based on Capture field values.

  1. On the Check-In tab of the Oracle UCM 11g Commit Settings Screen, select the Assign values dynamically field, then choose By Field Mappings. This adds <Account>, <Content Type>, and <Security Group> metadata mappings to the Field Mappings tab.

  2. On the Field Mappings tab of the Oracle UCM 11g Commit Settings Screen, select a Capture index field for each of the metadata mappings fields.


    Note:

    If you do not map the <Account>, <Content Type>, or <Security Group> fields, the value specified in the corresponding <Default Type>, <Default Security Group>, or <Default Account> field on the Check-In tab is used.

17.6.2.3 Based on User's Pick-list Selections

When you assign values using this method, a combination of metadata values is assigned based on a user's pick-list selection. For example, if a user selects a value of Invoice from a pick-list index field, the document might be assigned a type of ACCTG, a security group of Finance, and no account value (<No Account> selected).

This configuration requires a Capture pick-list.

  1. On the Check-In tab of the Oracle UCM 11g Commit Settings Screen, select the Assign values dynamically field, then choose By Index Field.

  2. In the Index Field field, select the Capture field whose pick-list value will be used to assign type, security group, and account.

  3. In the Pick-list Source field, select Capture Native Pick-list or a previously created database pick-list.

  4. In the Pick-list field, select the pick-list from those available for the source you selected.

  5. Click Add.

  6. In the Add Metadata Mappings screen that is displayed, select one or more field values and select options in the Type, Security Group, and Account fields.


    Note:

    The Type, Security Group, and Account fields each contain a default option (for example, <Default Type>). Select one of these default options to use the value specified in the corresponding default field on the Check-In tab (for example, Default Type field). This can simplify changing the default for many mappings by changing the default value on the Check-In tab.


    Note:

    The Account field contains a <No Account> option that you can select to skip assigning a value to the Account metadata field. (Type and Security Group are required and cannot be skipped.)

  7. Repeat steps 5 and 6 to continue mapping field values.

17.7 Configuring an Oracle I/PM 10g Commit Profile

Follow these steps to configure a commit profile that write documents from Capture to Oracle I/PM 10g. For direct and indirect guidelines, see "About the Oracle I/PM 10g Commit Driver".


Note:

In order to file documents directly from Capture to Oracle I/PM, the Oracle I/PM client must be installed on all Capture workstations that perform batch commits. If the Commit Server is performing all batch commits, Oracle I/PM must be installed on the Commit Server only.

  1. In the Capture Administration screen, create a commit profile.

    See "Adding a Commit Profile".

  2. In the Commit Driver field, select the Oracle I/PM Commit Driver. Click the Configure button.

    The Oracle I/PM Commit Driver Settings dialog box is displayed.

  3. On the General tab, specify one or both commit methods.

    Choose Direct Connect to archive documents directly into Oracle I/PM. Choose Filer File Commit to create an Oracle Filer file for each committed batch. Its corresponding tab becomes active.

  4. If committing directly into Oracle I/PM, complete settings on the Direct Commit tab.

    Click the Field Mappings button and map Capture fields to Oracle I/PM fields. Field data types must match to successfully archive documents from Capture directly into Oracle I/PM.

  5. Configure Process Integration options (optional).

    See "Configure Process Integration Options".

  6. If committing documents to Filer files, complete settings on the Filer Commit tab.

    The Filer Path can be either a mapped drive letter or a UNC path; however, Oracle I/PM prefers a mapped drive letter. It is recommended that the path be configured the same on all Capture workstations, and the Oracle I/PM Filer program must have access to the path.

  7. On the Logging tab, enable and configure logging settings.

  8. On the Advanced tab, specify how multiple documents can be created for one or more batch pages (optional).

17.7.1 Configure Process Integration Options

Follow these steps to set up a Process integration.


Note:

You must have Process administrator rights. The user account is used exclusively by the Process integration as a service account to create and append Process packages.

  1. Select the Enable Process Integration field on the Direct Commit tab in the Oracle I/PM Commit Settings screen.

  2. In the Database field, specify a Process database.

  3. Click the Setup button.

    The Process Setup dialog box is displayed, listing Process configurations for the Oracle I/PM application selected in the Application field.

    A check mark indicates that the configuration is enabled. An asterisk identifies the default configuration.

  4. Click New.

  5. Complete the settings on the tabs.

  6. Save the configuration.

17.8 Configuring an Oracle I/PM 11g Commit Profile

Follow these steps to configure a commit profile that write documents from Capture to Oracle I/PM 11g. You can commit to Oracle I/PM 11g using either of these methods:

For more information, see "About the Oracle I/PM 11g Commit Driver".

17.8.1 Configuring a Direct Commit

Follow these steps to configure a commit profile that writes documents from Capture 10gR3 to Oracle I/PM 11g. Also see "About Direct Committing".

  1. In Capture Administration, create a commit profile.

    See "Adding a Commit Profile".


    Note:

    To use searching and appending options, the commit profile's document output format must be set to TIFF-Multiple Page.

  2. In the Commit Driver field, select the Oracle I/PM 11g Commit Driver.


    Note:

    Ensure that 11g is displayed in the commit driver name.

  3. Click the adjacent Configure button.

    The Oracle I/PM 11g Commit Driver Settings screen is displayed.

  4. On the General tab, leave the Direct Commit field selected.

  5. Log in to the Oracle I/PM instance by completing the User ID, Password, Security Policy, and Oracle I/PM Web Service URL fields and clicking Connect.

    Each time users commit using the profile, Capture uses this login information to connect to Oracle I/PM via the specified web service.

  6. Click the Field Mappings tab, select the Oracle I/PM Application to commit to, and map Capture fields to Oracle I/PM fields. (The data type of mapped fields must match.)

  7. On the Advanced tab, specify options for searching, appending, and logging.


    Note:

    Searching requires a search definition previously created in Oracle I/PM administration that specifies how documents are matched.

    If you selected the Search and Append to Matching I/PM Documents field, select a definition in the Search Definition field.

  8. On the Advanced tab, optionally enable logging. If enabled, specify a location in which to write the files and whether to log all actions or errors only. Click OK.

  9. Activate and test the commit profile.

    • In Capture Administration, choose Commit Profiles in the side pane. Select the Active field for the Oracle I/PM 11g commit profile you created so that a check mark is displayed.

    • Commit a document in a Capture component.

    • Search for and view the document in Oracle I/PM.

17.8.2 Configuring an Input Agent Commit

Follow these steps to configure a commit profile that writes input files from Capture 10gR3 to Oracle I/PM 11g for processing by an Oracle I/PM input agent. Also see "About Input Agent Committing".


Note:

An Oracle I/PM input definition is required for configuring an input agent commit. For more information, see the Oracle Fusion Middleware Administrator's Guide for Oracle Imaging and Process Management.

  1. In Capture Administration, create a commit profile.

    See "Adding a Commit Profile".

  2. In the Commit Driver field, select the Oracle I/PM 11g Commit Driver.


    Note:

    Be sure that 11g is displayed in the commit driver name.

  3. Click the adjacent Configure button.

    The Oracle I/PM Commit Driver Settings screen is displayed.

  4. On the General tab, select Input Agent Commit as the commit method.

  5. Log in to the Oracle I/PM instance by completing the User ID, Password, Security Policy, and I/PM Web Service URL fields and clicking Connect.

  6. In the Capture Output Directory field, specify the directory in which to write the input files and images.


    Note:

    The Capture Output Directory can be either a mapped drive letter or a UNC path. This path must be accessible on all Capture workstations/servers that perform document committing, and the Oracle I/PM Input Agent service must have access to the directory.

    The Capture output directory and the Input Agent input directory refer to the same location in different ways.


  7. In the Input Agent Input Directory field, select a directory configured for the selected Oracle I/PM instance.

  8. Click the Field Mappings tab, select the I/PM Input Definition to commit to, and map Capture fields to Oracle I/PM fields. (The data type of mapped fields must match.)

  9. On the Advanced tab, optionally enable logging. If enabled, specify a location in which to write the files and whether to log all actions or errors only.

  10. Activate and test the commit profile.

    • In Capture Administration, choose Commit Profiles in the side pane. Select the Active field for the Oracle I/PM 11g commit profile you created.

    • Commit a document in a Capture component.

    • Search for and view the document in Oracle I/PM. (Documents must be processed by the Oracle I/PM input agent before users can view them in Oracle I/PM.)

17.9 Configuring a Text File Commit Profile

Follow these steps to change the text file commit driver's default settings. By default, Capture creates a quotation, comma-separated text file that contains the full path to each image file, followed by document index data. For more information, see "About the Text File Commit Driver".

  1. In the Capture Administration screen, select a Commit Text File profile.

    See "Adding a Commit Profile".

  2. Click the commit driver's Configure button.

    The Commit Text File Settings dialog box displays.

  3. On the General tab, specify how commit text files and document files will be written.

  4. On the Formatting tab, specify the fields and delimiters to include in the commit text file.

  5. Optionally, specify how document files will be named on the Document File Naming tab.

17.10 Configuring an EDP Commit Profile

Follow these steps to create a commit profile that uses an Electronic Document Provider (EDP) macro to commit documents. You might do this if your organization commits batches directly to an electronic content management system other than Oracle UCM or Oracle I/PM. For detailed information about writing macros for use in Capture, see the Developer's Guide for Oracle Document Capture.

  1. Create an Electronic Document Provider macro.

    Choose Manage Macros from the System menu, select Electronic Document Provider in the Category field, and click New. Import or write a macro using available EDP macro events.

  2. In the Capture Administration screen, create a commit profile.

    See "Adding a Commit Profile".

  3. In the Commit Driver field, select Electronic Document Provider. Click the commit driver's Configure button.

  4. In the Macro Selection dialog box, select an EDP macro from the Available Macros field and click OK.

17.11 Configuring a Database Commit Profile

Follow these steps to configure a commit profile that commits document index values to a database and files to either a folder (whose path is stored in the database) or to a database table (within an image/blob field).

  1. In the Capture Administration screen, add a commit profile.

    See "Adding a Commit Profile".

  2. In the Commit Driver field, select the Database Commit Driver. Click the commit driver's Configure button.

  3. On the Database tab of the Database Commit Settings screen, click the Configure button. Configure the database connection.

    See "Configuring a Database Connection".

  4. In the Document Table field, select the database table to which you want to commit documents.

  5. In the Parent Table field, select a parent table to search and write index values to while committing to the document table (optional).

    See "Committing to Parent and Document Tables (optional)".

  6. On the Document subtab, click Add and specify Capture index fields whose values you want written to document fields.

  7. Select the Commit tab and specify where documents will be committed (folder or image/blob field).


    Note:

    To commit documents to an image/blob field, select a field whose data type supports long binary data.

17.11.1 Committing to Parent and Document Tables (optional)

Follow these steps to write Capture values to two tables (a parent and a document table) linked by a key field. This option is typically used to search for one or more higher level values in a parent table (writing a new record if needed and allowed), and then use that information to insert records containing detailed values in the document table.


Note:

You can search multiple parent table fields or a single parent key field. For more information, see "About Committing Index Values to Linked Tables".

  1. On the Database tab of the Database Commit Settings screen, select a table in the Parent Table field.

  2. Click the Parent tab. Select the key field in Parent Key and Document Key fields.

    These fields must be of the same data type.


    Note:

    You do not need to designate the key fields as primary keys or define a join relationship between them in the database.

  3. In the table, click Add and map Capture fields to fields from the parent table.

  4. Apply optional settings if needed.

    • Select the Search using the parent key field only option to match records based solely on the parent key field. Otherwise, all mapped fields are used when searching the parent table.

    • The Include blank fields in search option controls whether records are matched when Capture searches the parent table and finds null values for mapped fields.

    • Select the Cancel commit if parent record not found field to skip document commit if no matching parent record is found.