Custom Domain in IQ Bot
- Updated: 2021/11/05
Custom Domain in IQ Bot
A domain contains information about the language of the documents and the fields that the system extracts from the documents. Besides the domains provided by IQ Bot, you can also create and add custom domains to your IQ Bot environment, which displays in the Document type drop-down list.
The Domains tab displays all available domains for use in the system and their associated languages. Besides out-of-box domains offered by IQ Bot, you can also create a custom domain and import it into IQ Bot.
Create a custom domain (A-people login required)
When creating a learning instance using a custom domain:
- The languages assigned to the domain when creating the domain is displayed and is available for selection from the Primary language of documents drop-down list.
- The fields that were selected when creating the custom domain are displayed in the Fields to extract section of the create New instance page.
Classification issue with Chinese Invoices (A-People login required)
Import a domain
You import a domain for the following scenarios:
- Import a new domain.
- Import an existing domain from another system to your current system.
When you are ready to import a domain into your system:
- Go to the system where you want the domain to be imported.
- Click Import new domain in the
Domains tab and select the .dom
domain file in your local machine that you want to import.
The domain import success message is displayed in the Domains tab.
The imported domain appears for the selection in the Document type drop-down list of the create New instance page and is displayed in the domains list in the Domains page.
Export a domain
When you click the Export option next to a domain, it is exported to an output folder on your local drive. The exported domain is encrypted and is created with a .dom filename extension.
You export an existing domain from one IQ Bot system to import to another.
To export a domain from your IQ Bot system, do this: In the Domains list page, click the Export option next to the domain you want to export.
The system displays a success message for the exported domain.
The file is exported to a local output folder on your machine with a .dom filename extension.
Current limitations to the domain import and export actions
When you migrate learning instances that were created using a custom domain from one system to another, the field names and IDs must remain the same in the target machine as well. Otherwise, though the learning instances are imported, the custom domain will not be imported and the associated field names and IDs for the custom domain do not work in the imported learning instance. If you run the imported learning instance on documents, the documents will not be classified.
Even if you import the custom domain to your new system, the field names and IDs will still not match as these are automatically generated by the system. Hence classification will fail. This is the current limitation of the Migration Utility feature using a custom domain.
Workaround: Copy the alias database from the current machine to the target machine. Then migrate the learning instances, using a custom domain. Move all learning instances to the staging environment, and test them before moving the learning instance to the production environment.
Custom domain enhancements
Import custom domains in any order
When you migrate learning instances (created using a custom domain) from the staging server to the production server, migration fails unless you import the different versions of the custom domain in the same order as they were created.
As the capability to edit a custom domain to add additional fields and aliases was not available, the user had to create a new domain and add the additional fields and aliases to it. Then the user had to assign that new domain to the learning instance. So when the user wanted to use the new domain, they had to re-import the original and the new domain to the production server in the order they were created in.
Importing custom domain to IQ Bot production (A-People login required)
From release Automation 360 Build 5322, and IQ Bot Version 18.104.22.168 this restriction does not exist.
- You can edit and update an existing custom domain multiple times, and import them to the production server multiple times as well.
- You can import the custom domains in any order. The system successfully migrates the updated fields (form or table), and field aliases (variations of field values found in the training documents, associated with a field) to the production server.
IQ Bot performs document classification based on the defined fields and aliases of the version of custom domain used when the learning instance was created.
Editing the same custom domain (with additional fields) changes the version of the custom domain. For new learning instances created using the new version of the custom domain, classification occurs on the updated fields as well. The edited fields (whether form or table fields) are displayed in the learning instance with a double asterisk next to them to help identify them.