{"id":21623,"date":"2022-04-11T13:59:48","date_gmt":"2022-04-11T11:59:48","guid":{"rendered":"https:\/\/help.openbee.com\/open-bee-smart-capture\/administrator-guide\/document-type\/document-index\/"},"modified":"2026-05-13T09:37:30","modified_gmt":"2026-05-13T07:37:30","slug":"document-index","status":"publish","type":"page","link":"https:\/\/help.openbee.com\/en\/open-bee-smart-capture\/administrator-guide\/document-type\/document-index\/","title":{"rendered":"Document Index"},"content":{"rendered":"\n<ul class=\"wp-block-list\"><li><a href=\"#Indexdedocuments-AjouterunnouvelIndex\">Add a new Index<\/a><\/li><li><a href=\"#Indexdedocuments-Typesd'index\">Types of Indexes<\/a><ul><li><a href=\"#Indexdedocuments-Cha%C3%AEnedecaract%C3%A8res\">String<\/a><\/li><li><a href=\"#Indexdedocuments-Texte\">Text<\/a><\/li><li><a href=\"#Indexdedocuments-Date\">Date<\/a><\/li><li><a href=\"#Indexdedocuments-D%C3%A9cimal\">Decimal<\/a><\/li><li><a href=\"#Indexdedocuments-Num%C3%A9rique\">Digital<\/a><\/li><li><a href=\"#Indexdedocuments-Code%C3%A0barres\">Barcode  <\/a><ul><li><a href=\"#Indexdedocuments-Param%C3%A9tragedecode%C3%A0barres\">Barcode settings<\/a><\/li><li><a href=\"#Indexdedocuments-Regexs\">Regexs<\/a><\/li><\/ul><\/li><li><a href=\"#Indexdedocuments-Param%C3%A9trageavanc%C3%A9\">Advanced parameterization<\/a><ul><li><a href=\"#Indexdedocuments-Marqueur\">Marker<\/a><\/li><li><a href=\"#Indexdedocuments-Regex\">Regex<\/a><\/li><li><a href=\"#Indexdedocuments-R%C3%A8gles\">Menstruation<\/a><ul><li><a href=\"#Indexdedocuments-Valeurpard%C3%A9faut\">Default value<\/a><\/li><li><a href=\"#Indexdedocuments-R%C3%A8glesdezones\">Zone Rules<\/a><\/li><li><a href=\"#Indexdedocuments-R%C3%A8glesdecomparaison\">Comparison rules  <\/a><\/li><\/ul><\/li><li><a href=\"#Indexdedocuments-Transcodage\">Transcoding<\/a><\/li><\/ul><\/li><\/ul><\/li><\/ul>\n\n<p>The indexes present in Open Bee Smart Capture are completely free and configurable. It is possible to add, remove or modify them according to your needs.<\/p>\n\n<h1 class=\"wp-block-heading\" id=\"Indexdedocuments-AjouterunnouvelIndex\">Add a new Index<\/h1>\n\n<p>Adding an index is only possible on a generic template. This means that the changes applied to this model will be reflected in all the models present.<\/p>\n\n<p>To add an Index, simply click on the button <img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/276922490.png\"\/> :<\/p>\n\n<p>Give this new index a name. This can then be modified, however the name is used when creating the index to generate a unique and definitive identifier.<\/p>\n\n<p>You can then change the default configuration of the index before validating.<\/p>\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/276922491.png\" alt=\"\"\/><\/figure>\n\n<p>Each index has a general record that includes the following information in addition to the type:<\/p>\n\n<p>Search limit (in %) from the top of the document: Allows you to roughly narrow the search box of index values. If the index has customization, this area will not be taken into account.<\/p>\n\n<p>Search Box: Indicates whether the values are above or below the previously defined search limit.<\/p>\n\n<p>On: Allows you to stop using an index without deleting it. The latter will no longer be visible in the video coding screen.<\/p>\n\n<p>Required: If required, the index must be completed with a valid value so that the document can be validated.<\/p>\n\n<p>Manual entry: the index will not be searched in the document by Smart Capture, it will be up to the user to fill it in manually at the time of video coding. Enabling manual input also allows the use of scripting.<\/p>\n\n<h1 class=\"wp-block-heading\" id=\"Indexdedocuments-Typesd'index\">Types of Indexes<\/h1>\n\n<p>To improve the detection of values in Smart Capture, to facilitate manual entry, and to apply special processing to them, indexes are assigned types to detect them.<\/p>\n\n<p>There are two main families of indexes: primitive indexes that represent information related to documents, and therefore a value. And compound indexes , which are a collection of indexes.<\/p>\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/276922492.png\" alt=\"\"\/><\/figure>\n\n<p>Primitive indexes are divided into several subtypes, each with its own specificities.<\/p>\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Type<\/strong><\/td><td><strong>Markers<\/strong><\/td><td><strong>Regex<\/strong><\/td><td><strong>Transcoding<\/strong><\/td><td><strong>Zone Rule<\/strong><\/td><td><strong>Calculation rule<\/strong><\/td><td><strong>Type-specific<\/strong><\/td><\/tr><tr><td>Text<\/td><td>Yes<\/td><td>Yes<\/td><td>No<\/td><td>Yes<\/td><td>No<\/td><td>\u00a0<\/td><\/tr><tr><td>Digital<\/td><td>Yes<\/td><td>Yes<\/td><td>No<\/td><td>Yes<\/td><td>Yes<\/td><td>\u00a0<\/td><\/tr><tr><td>Decimal<\/td><td>Yes<\/td><td>Yes<\/td><td>No<\/td><td>Yes<\/td><td>Yes<\/td><td>Separator Option<\/td><\/tr><tr><td>Date<\/td><td>Yes<\/td><td>No<\/td><td>No<\/td><td>Yes<\/td><td>Yes<\/td><td>Format US<\/td><\/tr><tr><td>String<\/td><td>Yes<\/td><td>Yes<\/td><td>Yes<\/td><td>Yes<\/td><td>No<\/td><td>Remove Spaces<\/td><\/tr><tr><td>Bar code<\/td><td>\u00a0<\/td><td>\u00a0<\/td><td>\u00a0<\/td><td>\u00a0<\/td><td>\u00a0<\/td><td>Output Type Option<\/td><\/tr><\/tbody><\/table><\/figure>\n\n<h2 class=\"wp-block-heading\" id=\"Indexdedocuments-Cha&#xEE;nedecaract&#xE8;res\">String<\/h2>\n\n<p>String indexes are ideal for processing short alphanumeric information such as references, product codes, identification numbers, etc.<\/p>\n\n<p>There is a specific option to remove spaces. This option allows you to remove all the spaces present within the value, which is very useful for formalizing certain codes whose font would have led the OCR engine to add fictitious spaces, e.g. &#8220;457 &#8211; B 45&#8221; =&gt; &#8220;457-B45&#8221;<\/p>\n\n<h2 class=\"wp-block-heading\" id=\"Indexdedocuments-Texte\">Text<\/h2>\n\n<p>A text index is very similar to a string index, but has a larger input space in the video encoding and can accept line breaks.<\/p>\n\n<h2 class=\"wp-block-heading\" id=\"Indexdedocuments-Date\">Date<\/h2>\n\n<p>In order to properly manage dates, a special type is dedicated to them. For example, it allows you to display a calendar in the videocoding window to quickly enter dates.<\/p>\n\n<p>As a special option, it is possible to activate &#8220;US dates&#8221;. This means that the dates will be handled as being in the format: month\/days\/year as soon as it is ambiguous.<\/p>\n\n<h2 class=\"wp-block-heading\" id=\"Indexdedocuments-D&#xE9;cimal\">Decimal<\/h2>\n\n<p>The decimal type is optimized to find numeric values in the document. Example: the amounts of an invoice.<\/p>\n\n<h2 class=\"wp-block-heading\" id=\"Indexdedocuments-Num&#xE9;rique\">Digital<\/h2>\n\n<p>The decimal type is optimized to find numeric values in the document (integers).<\/p>\n\n<h2 class=\"wp-block-heading\" id=\"Indexdedocuments-Code&#xE0;barres\">Barcode<\/h2>\n\n<p>Barcode: it is capable of handling several different formats (Code 128, QRcode, etc.). This option requires an option to be enabled in the app&#8217;s configuration.<\/p>\n\n<p>Smart capture is able to identify and retrieve the value that corresponds to the barcode.<\/p>\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/276922499.png\" alt=\"\"\/><\/figure>\n\n<h3 class=\"wp-block-heading\" id=\"Indexdedocuments-Param&#xE9;tragedecode&#xE0;barres\">Barcode settings<\/h3>\n\n<p><strong>Index Type Barcode<\/strong><\/p>\n\n<p>In order to improve the detection of values in Smart Capture, to facilitate manual entry and to apply special processing to them, a new type is assigned to the indexes to detect them.<\/p>\n\n<p>In order to properly manage barcodes, a special type is dedicated to them. In particular, it allows you to retrieve the value that is in the barcode<\/p>\n\n<p>To set up this index, it is necessary to add an index by clicking on the  <img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/276922500.png\"\/><\/p>\n\n<p>Fill in the different fields (Index name, search limit, search box&#8230;)<\/p>\n\n<p>Select the <strong>&#8220;Barcode&#8221; <\/strong>index type as shown in the following interface:<\/p>\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/276922501.png\" alt=\"\"\/><\/figure>\n\n<p>You can also view and change the index setting from the Videocoding section<\/p>\n\n<h3 class=\"wp-block-heading\" id=\"Indexdedocuments-Regexs\">Regexs<\/h3>\n\n<p>it is ultra generic because as soon as an index is of the barcode type, Scan capture will focus only on the barcode value.<\/p>\n\n<h2 class=\"wp-block-heading\" id=\"Indexdedocuments-Param&#xE9;trageavanc&#xE9;\">Advanced parameterization<\/h2>\n\n<h3 class=\"wp-block-heading\" id=\"Indexdedocuments-Marqueur\">Marker<\/h3>\n\n<p>For indexes &#8220;captured&#8221; by Smart Capture, these are targeted to the document by analyzing the position of the value and that of its &#8220;marker&#8221;. A marker is a text element on the document that characterizes the value being searched. In the following example, the index is Total Tax-Exclusive. These markers are: number, invoice, N\u00b0 etc &#8230;. It is possible to modify this list to best fit the needs of the model.<\/p>\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/276922494.png\" alt=\"\"\/><\/figure>\n\n<h3 class=\"wp-block-heading\" id=\"Indexdedocuments-Regex\">Regex<\/h3>\n\n<p>It is also possible to modify the regexs that define the values you are looking for, via the regex tab. The regex list also contains a star on the right. When this is completed, the regex takes precedence. Smart Capture will therefore search for values using these favorite regexes. If it doesn&#8217;t find any values, it will use the other regexes to perform its search. It is therefore advisable to bookmark specific regexes whose results should be treated as a priority.<\/p>\n\n<h3 class=\"wp-block-heading\" id=\"Indexdedocuments-R&#xE8;gles\">Menstruation<\/h3>\n\n<p>It is possible to define rules for a date, decimal, or numeric index. These rules will be used to detect the best value for the index in question, to verify that this value is consistent with the others when the information is detected and\/or validated by the user, or to set a default value for the index.<\/p>\n\n<p>The rules are composed of:<\/p>\n\n<p>Value of Other Indexes<\/p>\n\n<p>Constant variables: For dates, a variable containing today&#8217;s date is available<\/p>\n\n<p>Decimal value<\/p>\n\n<p>Basic arithmetic operators: &#8220;\/&#8221;, &#8220;*&#8221;, &#8220;-&#8220;, &#8220;+&#8221;, &#8220;%&#8221;, &#8220;(&#8220;, &#8220;)&#8221;<\/p>\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/276922495.png\" alt=\"\"\/><\/figure>\n\n<h4 class=\"wp-block-heading\" id=\"Indexdedocuments-Valeurpard&#xE9;faut\">Default value<\/h4>\n\n<p>The default value is used to set a value to be applied in the event that no valid value could be found on the document, and this value could not be inferred by Smart Capture<\/p>\n\n<h4 class=\"wp-block-heading\" id=\"Indexdedocuments-R&#xE8;glesdezones\">Zone Rules<\/h4>\n\n<p>Zone rules allow you to narrow down the possible values for an index by setting a constraint related to the geographic position of the value relative to values in other indexes.<\/p>\n\n<h4 class=\"wp-block-heading\" id=\"Indexdedocuments-R&#xE8;glesdecomparaison\">Comparison rules<\/h4>\n\n<p>Comparison rules are important in Smart Capture because they are the way to provide the user with a consistent value deduction. But also to check that the values entered by the user are correct by prohibiting validation or by warning the user that the values entered are inconsistent.<\/p>\n\n<p>E.g. The amount excluding VAT must be equal to the Total including VAT minus the amount of VAT.<\/p>\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/276922496.png\" alt=\"\"\/><\/figure>\n\n<p>E.g.: It is not possible to validate a document whose date is greater than today&#8217;s date<\/p>\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/276922497.png\" alt=\"\"\/><\/figure>\n\n<h3 class=\"wp-block-heading\" id=\"Indexdedocuments-Transcodage\">Transcoding<\/h3>\n\n<p>The use of transcoding makes it possible to transcribe values into constants known to the software, but also to limit the possible values and to define a default value.<\/p>\n\n<figure class=\"wp-block-image\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/276922498.png\" alt=\"\"\/><\/figure>\n\n<p>From this tab, you can choose whether the index will be a drop-down list or not using the checkbox provided.<\/p>\n\n<p>The columns displayed are:<\/p>\n\n<p>Conditions: This column is visible only when the index is captured (not manual). These are the different values detected on the document for which the transcoding value will be applied. Simply enter text and press &#8220;ENTER&#8221;<\/p>\n\n<p>It is possible to use regexes in this column to target multiple values at once.<\/p>\n\n<p>Value: The value that will be displayed in the drop-down list is the value that will actually be attached to the document.<\/p>\n\n<p>Default Value: Allows you to define the default value that will be assigned to the document, if no value could be found on the document or the index is manual.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Add a new Index Types of Indexes String Text Date Decimal Digital Barcode Barcode settings Regexs Advanced parameterization Marker Regex Menstruation Default value Zone Rules Comparison rules Transcoding The indexes present in Open Bee Smart Capture are completely free and configurable. It is possible to add, remove or modify them according to your needs. Add [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":21578,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"templates\/ob-help-products.php","meta":{"footnotes":""},"class_list":["post-21623","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21623","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/comments?post=21623"}],"version-history":[{"count":1,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21623\/revisions"}],"predecessor-version":[{"id":21624,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21623\/revisions\/21624"}],"up":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21578"}],"wp:attachment":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/media?parent=21623"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}