{"id":52034,"date":"2022-12-08T11:18:59","date_gmt":"2022-12-08T18:18:59","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/?post_type=docs&p=52034"},"modified":"2022-12-08T11:18:59","modified_gmt":"2022-12-08T18:18:59","slug":"auto-kv-extraction-plugin","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/auto-key-value-learning-plugins\/auto-kv-extraction-plugin\/","title":{"rendered":"Auto KV Extraction Plugin"},"content":{"rendered":"

<\/a>Overview<\/h1>\n

Certified for:<\/strong> Ephesoft Transact 2022.1.01 or above<\/p>\n

The Auto Extraction plugin automatically generates key-value rules to extract data from a document based on values previously selected by operators on exported documents. This plugin is used with the Auto Export plugin.<\/p>\n

Benefits of the Auto Extraction plugin include:<\/p>\n

    \n
  1. Overriding the value populated by other extraction plugins based on the confidence score of the extracted value<\/li>\n
  2. Marking a field as \u201cforce review\u201d where the match level is below a configured threshold.<\/li>\n
  3. Using a single rules database per batch class or a shared system wide database.<\/li>\n<\/ol>\n

    <\/a>Installation<\/h1>\n
      \n
    1. In Ephesoft Transact, go to Administrator <\/strong>> System Configuration<\/strong>.<\/li>\n
    2. Select Workflow Management<\/strong>.<\/li>\n
    3. Drag and drop the ZIP file into the Import Plugin section.<\/li>\n<\/ol>\n

      \"Installation\"
      \nFigure 1. Import Plugin<\/em><\/p>\n

        \n
      1. Restart Ephesoft Transact.<\/li>\n<\/ol>\n

        Note:<\/strong> There is a known issue with the Infor IDM Export Plugins Phase 6 and earlier in that they remove an essential line from the applicationContext.xml file, located at [Ephesoft_Directory<\/em>]\\Application.<\/p>\n

        The following error may occur in the dcma-all.log<\/strong> file when you try to execute the plugin after restarting Transact:<\/p>\n

        Caused by: org.activiti.engine.ActivitiException: Unknown property used in expression: ${autokvextractionplugin.performAutoKVExtraction(batchInstanceID,key)}<\/pre>\n
        To resolve this error, add the following line into the applicationContext.xml <\/strong>file, located at [Ephesoft_Directory<\/em>]\\Application:<\/p>\n
        <import resource=\"file:C:\\Ephesoft\\SharedFolders\/customPluginJars\/*.xml\"\/><\/pre>\n
        Note:<\/strong> The above line assumes Transact is installed on C:\\Ephesoft\\.<\/p>\n
        <\/a>Configuration<\/h1>\n
          \n
        1. From the Batch Class Management <\/strong>page, select your batch class and click Open<\/strong>.<\/li>\n
        2. Go to Modules <\/strong>> Extraction<\/strong>.<\/li>\n
        3. Add the AUTO_KV_EXTRACTION <\/strong>plugin to the list of Selected Plugins<\/strong>.<\/li>\n<\/ol>\n
          \"Workflow1\"
          \nFigure 2. Selected Plugins<\/em><\/p>\n
            \n
          1. Click Deploy<\/strong> to update the workflow.<\/li>\n
          2. Go to Modules <\/strong>> Extraction <\/strong>> AUTO_KV_EXTRACTION<\/strong>.<\/li>\n
          3. Configure the plugin according to your requirements. Reference the table below for descriptions of the configurable properties.<\/li>\n<\/ol>\n
            \"Configuration\"
            \nFigure 3. Configurable Properties<\/em><\/p>\n\n\n\n\n\n\n\n\n\n\n
            Configurable Property<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
            Auto Extraction Enabled<\/td>\nThis switch enables the plugin. Set to True<\/strong> to enable.<\/td>\n<\/tr>\n
            Enabled DLF List (or Batch Class Relative path to list)<\/td>\nUse this field to configure the list of index fields that should be monitored during validation. There are two available ways to list the index fields:<\/p>\n
              \n
            • List of index fields separated by the pipe character ( | ).<\/li>\n<\/ul>\n
              Note<\/strong>: If only one field is listed, it must be terminated with a pipe character ( | ).<\/p>\n
                \n
              • Enter the relative path to a text file that lists each index field line by line. For example: scripts-config\\mydlflist.txt<\/strong><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
            Rules Filter Value DLF Name<\/td>\nUse this field to configure the rules to be filtered by a specific value, such as the Vendor ID, GST ID, or IBAN.<\/p>\n
            To create a filtered rule, enter the name of the index field by which the rule should be filtered.<\/p>\n
            Note<\/strong>: Leaving this field blank will create rules without a filter.<\/td>\n<\/tr>\n
            DLF Value Overwrite Mode<\/td>\nSelect Overwrite <\/strong>or Do Not overwrite<\/strong>.<\/p>\n
            The threshold option will overwrite only if the confidence calculated by Transact of a field is lower than the value below.<\/td>\n<\/tr>\n
            DLF Overwrite Confidence Threshold<\/td>\nThis property is only used for the Threshold DLF Overwrite Mode. Otherwise, enter 0.<\/td>\n<\/tr>\n
            DLF Force Review Threshold<\/td>\nAuto rules will be assigned a confidence based on Auto Confidence Values assignment logic.<\/p>\n
            If the confidence is below the value entered here, the DLF will be marked for operator review.<\/td>\n<\/tr>\n
            Rules Database Path<\/td>\nThis property defines the location of the database rules. There are three available ways to configure this property:<\/p>\n