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

<\/a>Overview<\/h2>\n

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

The purpose of this plugin is to automatically generate key-value (KV) extraction rules based on operator changes to monitored values during validation. This plugin is used with the Auto KV Extraction plugin<\/a>.<\/p>\n

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

    \n
  1. Monitoring any number of index fields.<\/li>\n
  2. Using a filter field to create rules against a filtered value. For example, for an Invoice you might create rules using the VAT number as the filtered value.<\/li>\n
  3. Depending on your business needs, you can either use a single rules database per batch class, or use a shared system-wide database.<\/li>\n<\/ol>\n

    <\/a>Installation<\/h2>\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\"<\/em><\/p>\n

      Figure 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<\/code> 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: ${autokvexportplugin.performAutoKVExport(batchInstanceID,key)}<\/pre>\n
        To resolve this error, add the following line back 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 at C:\\Ephesoft\\.<\/p>\n
        <\/a>Configuration<\/h2>\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>> Export<\/strong>.<\/li>\n
        3. Add the AUTO_KV_EXPORT<\/strong> plugin to the list of Selected Plugins<\/strong>. This must be before CLEANUP<\/strong>.<\/li>\n<\/ol>\n
          \"Workflow1\"<\/p>\n
          Figure 2. Selected Plugins<\/em><\/p>\n
            \n
          1. Click Deploy <\/strong>to update the workflow.<\/li>\n
          2. Go to Modules <\/strong>> Export <\/strong>> AUTO_KV_EXPORT<\/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\"<\/p>\n
            Figure 3. Configurable Properties<\/em><\/p>\n\n\n\n\n\n\n\n
            Configurable Property<\/strong><\/th>\nDescription<\/strong><\/th>\n<\/tr>\n
            Auto Export Enabled<\/th>\nThis switch enables the plugin. Set to True<\/strong> to enable.<\/th>\n<\/tr>\n
            Enabled DLF List (or Batch Class Relative path to list)<\/th>\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<\/th>\n<\/tr>\n
            Rules Filter Value DLF Name<\/th>\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.<\/th>\n<\/tr>\n
            Rules Database Path<\/th>\nThis property defines the location of the database rules. There are three available ways to configure this property:<\/p>\n