How to use an Opticon file when importing a Clearwell Production Export into Clearwell

book

Article ID: 100038565

calendar_today

Updated On:

Description

INTRODUCTION

In order to use an Opticon file when importing a Clearwell Production Export into Clearwell, the export options must include the relevant fields to indicate the parent-child relationships. The choice of these fields is dependent on the export option "File Naming". 

  1. With Production Export setting "File Naming" set to "Clearwell Document ID".


    • Creating the Export.

      When the export option "File Naming" is set to "Clearwell Document ID" the Opticon file created by Clearwell will use the document ID as the image identifier (Figure 1A).

      Figure 1A.

      Note: As it stands, this Opticon file cannot be used by a Clearwell load file import, because lines 3 and 4 are using the same identifier (0.7.13.32887.1). If this particular Opticon file is used in a Clearwell load file import, the following error is seen in the remote job log:

      2014-08-20 15:39:13,576 ERROR [esa.imports.ImportDocRelationshipHandlerHelper] (LoadFileDocumentDiscovererThread_1:) CaseName:[LFI_DOCUMENT_ID] [#560203] Incorrect entry in opticon file Opticon DOCID same as line 3 File C:\Users\Administrator.CLEARWELL1\Downloads\EXPORT_DOCUMENT_ID\opticon.csv for DocID 0.7.13.32887.1
       

      As can bee seen from Figure 1A, this particular Opticon file is using a separate TIFF image file for each page of the same document. This is a problem, because each page in the same document is using the same image identifier. To avoid this issue, the Clearwell export option "Each File" needs to set to "Multiple Pages". This creates a multi-page TIFF document, i.e. there will only be one TIFF image file for each document (Figure 1B).

      Figure 1B.

      The Opticon file created by Clearwell will now look like Figure 1C.

      Figure 1C.

      Notice that there is now only one image row for each document. This ensures that there are no duplicate image identifiers in the Opticon file.


      Because document IDs are being used as the image identifier in the Opticon file, the parent-child relationships in the load file generated by the Clearwell export also need to be specified in terms of document IDs. This is how Clearwell can later match-up the Opticon image files with the documents they belong to.

      This is achieved by including the "DocID and "ParentID" fields in the "Metadata Fields" picker (Figure 1D).

      Figure 1D.



    • Importing the Export.

      When importing the export, Clearwell needs to match the Opticon image identifiers to the corresponding parent or child document. In order to do this, the document relationships in the load file import settings must be specified using the Doc ID values (Figure 1E).

      Figure 1E.


      Note: If the load file import settings are using the Doc ID values to identify the parent-child relationships, but the Opticon file is not using document ID values for the image identifiers, a warning similar to the following will be seen during discovery in the remote job log:

      2014-08-20 16:23:43,198 WARN [esa.imports.ImportDocRelationshipHandlerHelper] (LoadFileDocumentDiscovererThread_1:) CaseName:[LFI_DOCUMENT_ID_MP] [#560000] Handler warning No image files for DocID: 0.7.13.32887
      2014-08-20 16:23:43,198 WARN [esa.imports.ImportDocRelationshipHandlerHelper] (LoadFileDocumentDiscovererThread_1:) CaseName:[LFI_DOCUMENT_ID_MP] [#560211] WARN [#560003] Import warning No Image file for document. At line 3

       

  2. With Production Export setting "File Naming" set to "Production Number".


    • Creating the Export.
    • When the export option "File Naming" is set to "Production Number”, the Opticon file created by Clearwell will use the document production numbers (Figure 2A).

      Figure 2A.

      Figure 2A indicates that the “Single Page” option was chosen, because some lines end with a value greater than “1”, indicating multiple single pages associated with the same document.

      Because document production numbers are being used as the image identifiers in the Opticon file, the parent-child relationships in the load file generated by the Clearwell export need to be specified in terms of “BegDoc/EndDoc” and “BegAttach/EndAttach”. This is how Clearwell can match-up the Opticon image files with the documents they belong to. This is achieved by including the "BegDoc/EndDoc” and “BegAttach/EndAttach” fields in the export settings (Figure 2B).

      Figure 2B.


    • Importing the Export.

      When importing the export, Clearwell needs to match the Opticon image identifiers to the corresponding parent or child document. In order to do this, the document relationships in the load file import settings must be specified using the settings shown in Figure 2C.

      Figure 2C.

      Note: If the load file import settings are using the ‘Range’ values, but the Opticon file is using document ID values for the image identifiers, a warning similar to the following will be seen during discovery in the remote job log:

      2014-08-21 05:21:13,909 WARN [esa.imports.ImportDocRelationshipHandlerHelper] (LoadFileDocumentDiscovererThread_1:) CaseName:[LFI_PROD_NUMBER_SP1] [#560000] Handler warning No image files for DocID: 0000002
      2014-08-21 05:21:13,909 WARN [esa.imports.ImportDocRelationshipHandlerHelper] (LoadFileDocumentDiscovererThread_1:) CaseName:[LFI_PROD_NUMBER_SP1] [#560211] WARN [#560003] Import warning No Image file for document. At line 3

 

With Production Export setting "File Naming" set to "Clearwell Document ID".


  • Creating the Export.

    When the export option "File Naming" is set to "Clearwell Document ID" the Opticon file created by Clearwell will use the document ID as the image identifier (Figure 1A).

    Figure 1A.

    Note: As it stands, this Opticon file cannot be used by a Clearwell load file import, because lines 3 and 4 are using the same identifier (0.7.13.32887.1). If this particular Opticon file is used in a Clearwell load file import, the following error is seen in the remote job log:

    2014-08-20 15:39:13,576 ERROR [esa.imports.ImportDocRelationshipHandlerHelper] (LoadFileDocumentDiscovererThread_1:) CaseName:[LFI_DOCUMENT_ID] [#560203] Incorrect entry in opticon file Opticon DOCID same as line 3 File C:\Users\Administrator.CLEARWELL1\Downloads\EXPORT_DOCUMENT_ID\opticon.csv for DocID 0.7.13.32887.1
     

    As can bee seen from Figure 1A, this particular Opticon file is using a separate TIFF image file for each page of the same document. This is a problem, because each page in the same document is using the same image identifier. To avoid this issue, the Clearwell export option "Each File" needs to set to "Multiple Pages". This creates a multi-page TIFF document, i.e. there will only be one TIFF image file for each document (Figure 1B).

    Figure 1B.

    The Opticon file created by Clearwell will now look like Figure 1C.

    Figure 1C.

    Notice that there is now only one image row for each document. This ensures that there are no duplicate image identifiers in the Opticon file.


    Because document IDs are being used as the image identifier in the Opticon file, the parent-child relationships in the load file generated by the Clearwell export also need to be specified in terms of document IDs. This is how Clearwell can later match-up the Opticon image files with the documents they belong to.

    This is achieved by including the "DocID and "ParentID" fields in the "Metadata Fields" picker (Figure 1D).

    Figure 1D.



  • Importing the Export.

    When importing the export, Clearwell needs to match the Opticon image identifiers to the corresponding parent or child document. In order to do this, the document relationships in the load file import settings must be specified using the Doc ID values (Figure 1E).

    Figure 1E.


    Note: If the load file import settings are using the Doc ID values to identify the parent-child relationships, but the Opticon file is not using document ID values for the image identifiers, a warning similar to the following will be seen during discovery in the remote job log:

    2014-08-20 16:23:43,198 WARN [esa.imports.ImportDocRelationshipHandlerHelper] (LoadFileDocumentDiscovererThread_1:) CaseName:[LFI_DOCUMENT_ID_MP] [#560000] Handler warning No image files for DocID: 0.7.13.32887
    2014-08-20 16:23:43,198 WARN [esa.imports.ImportDocRelationshipHandlerHelper] (LoadFileDocumentDiscovererThread_1:) CaseName:[LFI_DOCUMENT_ID_MP] [#560211] WARN [#560003] Import warning No Image file for document. At line 3

     

With Production Export setting "File Naming" set to "Production Number".


  • Creating the Export.
  • When the export option "File Naming" is set to "Production Number”, the Opticon file created by Clearwell will use the document production numbers (Figure 2A).

    Figure 2A.

    Figure 2A indicates that the “Single Page” option was chosen, because some lines end with a value greater than “1”, indicating multiple single pages associated with the same document.

    Because document production numbers are being used as the image identifiers in the Opticon file, the parent-child relationships in the load file generated by the Clearwell export need to be specified in terms of “BegDoc/EndDoc” and “BegAttach/EndAttach”. This is how Clearwell can match-up the Opticon image files with the documents they belong to. This is achieved by including the "BegDoc/EndDoc” and “BegAttach/EndAttach” fields in the export settings (Figure 2B).

    Figure 2B.


  • Importing the Export.

    When importing the export, Clearwell needs to match the Opticon image identifiers to the corresponding parent or child document. In order to do this, the document relationships in the load file import settings must be specified using the settings shown in Figure 2C.

    Figure 2C.

    Note: If the load file import settings are using the ‘Range’ values, but the Opticon file is using document ID values for the image identifiers, a warning similar to the following will be seen during discovery in the remote job log:

    2014-08-21 05:21:13,909 WARN [esa.imports.ImportDocRelationshipHandlerHelper] (LoadFileDocumentDiscovererThread_1:) CaseName:[LFI_PROD_NUMBER_SP1] [#560000] Handler warning No image files for DocID: 0000002
    2014-08-21 05:21:13,909 WARN [esa.imports.ImportDocRelationshipHandlerHelper] (LoadFileDocumentDiscovererThread_1:) CaseName:[LFI_PROD_NUMBER_SP1] [#560211] WARN [#560003] Import warning No Image file for document. At line 3

Issue/Introduction

How to use an Opticon file when importing a Clearwell Production Export into Clearwell