Document Intelligence properties

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Document Intelligence properties

    Document Intelligence system properties allow you to configure and control the behavior of the Document Intelligence application within ServiceNow. These properties affect the user interface and processing logic in the Document Intelligence workspace, enabling customization to better suit operational needs. The DocIntel Manager (sndocintel.manager role) is authorized to modify these properties.

    Show full answer Show less

    With the release of Document Intelligence 3.0, several system properties have been updated or introduced to enhance functionality and management, especially around machine learning model training and document extraction behavior.

    Key Features

    • Interface customization: Properties like sidebar widths, panel layout positions, and image fit settings allow you to tailor the Document Intelligence workspace layout for better usability. Examples include defaultfieldsidebarwidth, fieldsidebarlayoutposition, and defaultimagefit.
    • Confidence and scoring controls: Properties such as showcandidatescore, showexactmatchoption, and various score thresholds (warningscorethreshold, autofillthreshold, straightthroughprocessingthreshold) let you manage how confidence scores are displayed and used to automate data extraction and validation processes.
    • Machine learning management (3.0+): New properties control the frequency of document classifier training (daysbetweentrainings) and refine extraction parameters under the glide.platformmldi.docdataextractor namespace.
    • Draw tool enablement: The drawtoolenable property allows enabling or disabling draw tool features used for table extraction, facilitating manual adjustments in data capture.

    Practical Use and Benefits

    By configuring these system properties, ServiceNow customers can:

    • Optimize the Document Intelligence workspace layout for improved user experience and efficiency.
    • Control the level of automation and accuracy in data extraction by setting appropriate confidence thresholds.
    • Manage machine learning model retraining schedules to maintain classifier accuracy without excessive resource use.
    • Enable or disable interactive tools like the draw tool to suit specific document processing requirements.

    These configurations help ensure that Document Intelligence operates in a way that aligns with organizational workflows, improving data accuracy and reducing manual intervention.

    Document Intelligence (DocIntel) system properties control the behavior of the Document Intelligence application.

    The DocIntel Manager (sn_docintel.manager) can modify the system properties for DocIntel.

    Note:

    Document Intelligence 3.0 includes new and updated system properties. For more detail about the upgrade, see Upgrade to Document Intelligence 3.0 or later from version 2.4 or earlier.

    Document Intelligence 2.4- system properties

    Property name Description Values
    sn_docintel.default_field_sidebar_width The default sidebar width for the document fields panel in the Document Intelligence workspace.

    Allowed: Format of [integer]px

    Default: 416px
    sn_docintel.default_image_fit

    The default image fit for the document panel viewer in the Document Intelligence workspace.

    Allowed: fit_to_page, fit_to_width

    Default: fit_to_page
    sn_docintel.default_thumbnail_sidebar_width The default thumbnail sidebar width for the navigation panel in the Document Intelligence workspace.

    Allowed: Format of [integer]px

    Default: 167px
    sn_docintel.field_sidebar_layout_position The layout position for the document fields panel in the Document Intelligence workspace, in relation to the document fields panel sidebar.

    Allowed: right, left

    Default: right
    sn_docintel.show_exact_match_option Show the exact match option for each field in the document fields panel in the Document Intelligence workspace.

    Allowed: true, false

    Default: true
    sn_docintel.show_candidate_score Show confidence scores on the recommendations selection menu in the document fields panel in the Document Intelligence workspace.

    Allowed: true, false

    Default: true
    sn_docintel.warning_score_threshold Threshold used to show the warning icon for low-score recommendations in the document fields panel in the Document Intelligence workspace.

    Allowed: Number between 0.0 and 1.0

    Default: 0.7
    sn_docintel.autofill_threshold Minimum score threshold required to auto-fill recommendations.

    Allowed: Number between 0.0 and 1.0

    Default: 0.0
    sn_docintel.straight_through_processing_threshold Minimum score threshold required for straight-through processing of a document task.

    Allowed: Number between 0.0 and 1.0

    Default: 1.0

    Document Intelligence 3.0+ system properties

    Property name Description Values
    glide.platform_ml_di.doc_classifier. days_between_trainings

    Document classifier property

    Minimum number of days between trainings for a given document classifier use case.

    		 Default: 30
    glide.platform_ml_di.doc_data_extractor. warning_score_threshold

    Document extraction property

    Threshold used to show the warning icon for low-score recommendations in the document fields panel in the Document Intelligence workspace.

    Allowed: Number between 0.0 and 1.0

    Default: 0.7
    glide.platform_ml_di.doc_data_extractor. straight_through_processing_threshold

    Document extraction property

    Minimum score threshold required for straight-through processing of a document task.

    Allowed: Number between 0.0 and 1.0

    Default: 1.0
    glide.platform_ml_di.doc_data_extractor. show_exact_match_option

    Document extraction property

    Show the exact match option for each field in the document fields panel in the Document Intelligence workspace.

    Allowed: true, false

    Default: true
    glide.platform_ml_di.doc_data_extractor. show_candidate_score

    Document extraction property

    Show confidence scores on the recommendations selection menu in the document fields panel in the Document Intelligence workspace.

    Allowed: true, false

    Default: true
    glide.platform_ml_di.doc_data_extractor. field_sidebar_layout_position

    Document extraction property

    The layout position for the document fields panel in the Document Intelligence workspace, in relation to the document fields panel sidebar.

    Allowed: right, left

    Default: right
    glide.platform_ml_di.doc_data_extractor. default_thumbnail_sidebar_width

    Document extraction property

    The default thumbnail sidebar width for the navigation panel in the Document Intelligence workspace.

    Allowed: Format of [integer]px

    Default: 167px
    glide.platform_ml_di.doc_data_extractor. default_image_fit

    Document extraction property

    The default image fit for the document panel viewer in the Document Intelligence workspace.

    Allowed: fit_to_page, fit_to_width

    Default: fit_to_page
    glide.platform_ml_di.doc_data_extractor. default_field_sidebar_width

    Document extraction property

    The default sidebar width for the document fields panel in the Document Intelligence workspace.

    Allowed: Format of [integer]px

    Default: 416px
    glide.platform_ml_di.doc_data_extractor. autofill_threshold

    Document extraction property

    Minimum score threshold required to auto-fill recommendations.

    Allowed: Number between 0.0 and 1.0

    Default: 0.01
    glide.platform_ml_di.doc_data_extractor. draw_tool_enable

    This property is used to enable or disable draw tool features for table extraction.

    Allowed: true, false

    Default: true