Upgrade to Document Intelligence 3.0 or later from version 2.4 or earlier
Document Intelligence 3.0 or later includes an updated database schema to support its transition from a scoped application to a ServiceNow AI Platform plugin.
Important: Starting with the Zurich release, Document Intelligence is being prepared for future deprecation. It will be hidden and no longer activated on new instances but will continue to be supported. For details, see the Deprecation Process article [KB0867184] in the Now Support Knowledge Base. Instead, you can extract information from documents using the Now Assist in Document Intelligence application. For more information, see Now Assist in Document Intelligence.
Upgrade tasks
Review the information in this topic before you upgrade to Document Intelligence (DocIntel) 3.0 or later from version 2.4 or earlier.
For more information on installation, see Install Document Intelligence.
Before the upgrade
| Pre-upgrade task | Description |
|---|---|
| Choose a time to schedule the upgrade | Avoid performing the upgrade during the run time of the nightly task definition \(use case\) upgrade job. Upgrading the application at that time would prevent use cases from upgrading until the run time of the next day. |
| Update any custom code that points directly to DocIntel database tables | After upgrading to Document Intelligence 3.0 or later from version 2.4 or earlier, DocIntel will use new flow actions. DocIntel will also use ServiceNow AI Platform database tables (sys_di_) in place of the scoped application tables (di_). All DocIntel data will be migrated automatically to these platform tables. Note: Document extraction use cases may not be available for use until the migration is complete. If you have custom code in your instance that points directly to the scoped application tables (di_), it should be updated, preferably to the platform component using DocIntel APIs. If you have custom code using DocIntel 2.4 or earlier flow actions, it should be updated to use 3.0 or later flow actions. For the list of tables, see Components installed with Document Intelligence. |
| Add cross-scope records for integrations | For any integrations with Document Intelligence, add cross-scope records for the new DocIntel database tables. Note: Ensure that the existing cross-scope records for the old tables are not removed. See the Cross-scope records section for the list of records to be added. For more detail on cross-scope records, see . |
During the upgrade
| Upgrade task | Description |
|---|---|
| Avoid using the Document Intelligence workspace to extract fields | Wait until a document task is migrated to the sys\_di\_task table before completing it using the Document Intelligence workspace. Completing a task during the upgrade may lead to data loss. |
After the upgrade
| Post-upgrade task | Description |
|---|---|
| Test DocIntel integrations and custom workflows | Test your use case integrations to ensure they function with the new database schema. |
| Check for data loss | Some cases where you can lose data include: - Any action resulting in the attachment deletion in an old di\_task record would result in a missing attachment for the new sys\_di\_task record. - Deletion of any new tasks created during the data migration \(that is, during or right after the 3.0 or later upgrade\) would result in permanent deletion as those records might not have entries in di\_task tables. - Deletion of an old “process\_task” flow \(or any action resulting in that flow deletion\) would result in an empty flow reference in the new integration setup records. |
| Post-upgrade migration of legacy use cases imported through update sets | At any time after the completion of the Document Intelligence 3.0 or later upgrade and data migration, you can rerun the migration batch script that ran during the upgrade. You may want to run this script if you must migrate any imported use cases requiring migration to the platform tables (sys_di_).
Warning: Never use the DocIntel migrate remaining data batch job to rerun migration after deleting all records from sys_di tables. You should only use it to migrate missing data from di_ tables to sys_di tables. |
Cross-scope records
| Source scope | Target scope | Target name | Operation | Target type | Status |
|---|---|---|---|---|---|
| Scope of integrating BU | global | sys_di_task | Read | Table | Allowed |
| Scope of integrating BU | global | sys_di_key | Read | Table | Allowed |
| Scope of integrating BU | global | sys_di_key_group | Read | Table | Allowed |
| Scope of integrating BU | global | sys_di_ocr_input | Read | Table | Allowed |
| Scope of integrating BU | global | sys_di_pdf_input | Read | Table | Allowed |
| Scope of integrating BU | global | sys_di_prediction_input | Read | Table | Allowed |
| Scope of integrating BU | global | sys_di_training_input | Read | Table | Allowed |
| Scope of integrating BU | global | sys_di_key_hint | Read | Table | Allowed |