Installation
How to install & configure KV² Plugin#
KV² Plugin is installed directly in Ephesoft Transact. The installation process is same for instances set up in Cloud or On Premise.
Prerequisites#
- Download the KV² Plugin from here
Note: KV² Plugin consist of two zip files!
- You must have Administration rights in Ephesoft Transact.
- You must have set up a working Batch Class or install Polydocs GmbH default Batch Class for Plugin usage if no Batch Class is set up in your Ephesoft System, yet. (Contact us to get the Polydocs GmbH default Batch Class)
Installation#
Step 1: Access your Infor OS and open IDM Capture in the menu on the top left.#
Step 2: Open your Ephesoft Transact system#
Step 3: As an Admin please click into the Administrator section and select eg. "Batch Class Management". Open the menu bar on the left and click "System Configuration".#
Step 4: Open Workflow Management#
Drag & Drop or upload both plugin zip files into the "Import Plugin" area to auto-install the plugin.
Note: Make sure that file name is exactly "fellowkv2exportplugin.zip" / "fellowkv2extractplugin.zip" and that the files are not renamed (eg by downloading multiple times) as Ephesoft cannot recognize files with another name.
Make sure that the installation was successful by checking the list under Workflow Management if the 2 new plugins are listed (sample below).
The Installation part of the plugin is now done and it can be associated to a Batch Class and configured.
Association to Batch Class & Configuration#
Step 1: Open the menu bar on the left and click "Batch Class Management" and open the Batch Class in which the plugin should run#
Step 2: associate Extraction Module of the Plugin (FELLOW_KV2_EXTRACT)#
Click Modules and then Extraction on left side of Batch Class Configuration Screen. It will show all the Extraction modules configured for this Batch Class.
Find FELLOW_KV2_EXTRACT in "Associated Plugins" column and move it to "Selected Plugins" by click the right arrow button as shown in picture below.
IMPORTANT:
In the "Selected Plugins" column highlight the plugin and slide the plugin "FELLOW_KV2_EXTRACT" to be above "FUZZYDB" with the arrow pointing upwards, click "Apply" and then click "Deploy" to activate your changes.
Step 3: Configure Extraction Module of the Plugin (FELLOW_KV2_EXTRACT)#
Expand the "Extraction" folder in the left menu and select the newly added FELLOW_KV2_EXTRACT module.
Now set up Config details as described below and then click "Apply" and "Deploy"
| Field | Value | Description |
| KV2 Extraction Enabled (Version:1.0.3):* | True | Here you can see the version number of the installed plugin and set value "True" for plugin activation |
| Enabled DLF List (Separated by | symbol):* | INVOICE_NUMBER|INVOICE_DATE|PURCHASE_ORDER| DELIVERY_DATE|PAYMENT_TERMS|TOTAL_AMOUNT| TAX_RATE|NET_AMOUNT|TAX_AMOUNT|TAX_RATE_2| NET_AMOUNT_2|TAX_AMOUNT_2|TAX_RATE_3|NET_AMOUNT_3| TAX_AMOUNT_3|VAT_NO_EXTRACTED|IBAN_EXTRACTED | List of all Index fields that should be validated, written in upper cases to reflect Ephesoft field names, separated by pipe character ("|") |
| Key Values DLF Names (Separated by | symbol):* | VAT_NO_EXTRACTED|IBAN_EXTRACTED|VENDOR_ID | List of the Key Values |
| DLF Value Overwrite Mode: | select one of following possibilities: - Do Not Overwrite Populated DLFs - Always Overwrite Populated DLFs - Overwrite Populated DLFs With Confidence Below Threshold | Select Overwrite or Do Not overwrite. The threshold option will overwrite only if the confidencecalculated by Transact of a field is lower than the value below |
| DLF Overwrite Confidence Threshold:* | 50 | This property is only used for the Threshold DLF OverwriteMode. Otherwise, enter 0. |
| DLF Force Review Threshold:* | 50 | Auto rules will be assigned a confidence based on AutoConfidence Values assignment logic. If the confidence is below the value entered here, the DLF will bemarked for operator review. |
| KV2 Webservice URL:* | https://cloudintegration.eu/api/fellowkv/extract/get_tfidf_rules | link to the Fellow cloud repository |
| Fellow Webservice API Key:* | -- provided by Fellow Consulting per subscription -- | personal API key to connect to Fellow Cloud repository |
Step 4: associate Export Module of the Plugin (FELLOW_KV2_EXPORT)#
Click Modules and then Export on left side of Batch Class Configuration Screen. It will show all the Export modules configured for this Batch Class.
Find FELLOW_KV2_EXPORT in "Associated Plugins" column and move it to "Selected Plugins" by click the right arrow button as shown in picture below.
IMPORTANT:
In the "Selected Plugins" column highlight the plugin "FELLOW_KV2_EXPORT" and slide it to the top with the arrow pointing upwards, click "Apply" and then click "Deploy" to activate your changes.
Step 5: Configure Export Module of the Plugin (FELLOW_KV2_EXPORT)#
Expand the "Export" folder in the left menu and select the newly added FELLOW_KV2_EXPORT module.
Now set up Config details as described below and then click "Apply" and "Deploy"
| Field | Value | Description |
| KV2 Export Enabled (Version:1.0.3):* | True | Here you can see the version number of the installed plugin and set value "True" for plugin activation |
| Enabled DLF List (Separated by | symbol):* | INVOICE_NUMBER|INVOICE_DATE|PURCHASE_ORDER|DELIVERY_DATE| PAYMENT_TERMS|TOTAL_AMOUNT|TAX_RATE|NET_AMOUNT| TAX_AMOUNT|TAX_RATE_2|NET_AMOUNT_2|TAX_AMOUNT_2| TAX_RATE_3|NET_AMOUNT_3|TAX_AMOUNT_3| VAT_NO_EXTRACTED|IBAN_EXTRACTED | List of all Index fields that should be validated, written in upper cases to reflect Ephesoft field names, separated by pipe character ("|") |
| Key Values DLF Names (Separated by | symbol):* | VAT_NO_EXTRACTED|IBAN_EXTRACTED|VENDOR_ID | |
| KV2 Webservice URL:* | https://cloudintegration.eu/api/fellowkv/export/export_rules | link to the Fellow cloud repository |
| Fellow Webservice API Key:* | -- provided by Fellow Consulting per subscription -- | personal API key to connect to Fellow Cloud repository |
The association and configuration part of the plugin is now done. Note that you have to re-start Transact server before you can start using the plugin.
Step 6: Deactivate extraction rules for not needed index fields.#
In order to deactivate the extraction rules in every field you have to go through every document type. So, when you open the batch class you will see the following list:
Now, start from the top and go through every document type following exactly the same steps.
As an example, let's start with document type INVOICE_DE. So, open the folder and you will see al index fields available.
Now, we can start with for instance the delivery date and you will need to deactivate the fields by checking off the box in the last column and clicking on "Apply" and "Deploy". It should look like this:
Please deactivate the rules for all index fields but CREDIT_NOTE, CURRENCY, IBAN_EXTRACTED, INVOICE and VAT_NO_EXTRACTED.
Step 7: Import the feedback fields.#
Please use this zip file for the import:
INVOICE_DE_FieldTypes-1Download
Now go through every document type and use the box underneath for "Import Index Field(s)" to select or drag and drop the zip file:
FINAL Step 8: Re-start Transact Server#
Read this Article for how to restart Transact