{"id":20472,"date":"2022-08-18T14:13:05","date_gmt":"2022-08-18T12:13:05","guid":{"rendered":"https:\/\/help.openbee.com\/open-bee-portal\/administrators-guide\/ranking-rules\/create-metadata\/auto-increment-metadata\/"},"modified":"2026-05-13T10:47:51","modified_gmt":"2026-05-13T08:47:51","slug":"auto-increment-metadata","status":"publish","type":"page","link":"https:\/\/help.openbee.com\/en\/open-bee-portal\/administrators-guide\/ranking-rules\/create-metadata\/auto-increment-metadata\/","title":{"rendered":"Auto increment metadata"},"content":{"rendered":"\n<p>Since version 6.13.0 of Open Bee\u2122 Portal a new type of metadata has been added, it is the auto increment type.<\/p>\n\n<p>The auto-increment metadata type is used to calculate a unique number. Compared to the old auto-increment mechanism that existed in previous versions, this new type brings two additional features:<\/p>\n\n<ul class=\"wp-block-list\"><li>Periodic metadata reset<\/li><li>A different calculation depending on the values of one or more metadata<\/li><\/ul>\n\n<p><\/p>\n\n<p><\/p>\n\n<h2 class=\"wp-block-heading\">Create auto-increment metadata<\/h2>\n\n<p>When a new metadata is created, a new type appears: the &#8221; <em>Auto increment&#8221;<\/em> type.<\/p>\n\n<figure class=\"wp-block-image size-large\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/image-7_auto-translated-1024x337.png\" alt=\"\" class=\"wp-image-13201\"\/><\/figure>\n\n<p>Autoincrement metadata is made up of three options:<\/p>\n\n<p><\/p>\n\n<h3 class=\"wp-block-heading\">Initial value<\/h3>\n\n<p>The initial value is the value that will be used at the collation of the first document to calculate the value of this metadata. The initial value is also used if the metadata is reset after one of the initial value reset conditions has been met.<\/p>\n\n<p>Entering an initial value is mandatory and must be greater than 1.<\/p>\n\n<h3 class=\"wp-block-heading\">Return to original value<\/h3>\n\n<p>By enabling the initial value discount, the administrator can configure an auto increment that restarts periodically according to the conditions determined by the administrator.<\/p>\n\n<p>It is possible to set a reset on a daily, weekly, monthly, or annual basis. It is possible to add multiple conditions. In the event that more than one condition is parameterized, the metadata will be reset as soon as one of the conditions is met.<\/p>\n\n<figure class=\"wp-block-image size-large\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/image-8_AUTO-translated-1024x393.png\" alt=\"\" class=\"wp-image-13202\"\/><figcaption>On the left, the metadata will be reset every 1st of the month. On the right, the metadata will be reset every October 15th<\/figcaption><\/figure>\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/image-9_AUTO-translated-1024x878.png\" alt=\"\" class=\"wp-image-13203\" width=\"840\" height=\"720\"\/><figcaption>On the left, the metadata will be reset quarterly. On the right, the metadata will be reset every two weeks<\/figcaption><\/figure>\n\n<p><\/p>\n\n<h3 class=\"wp-block-heading\">Increment by metadata value<\/h3>\n\n<p>By enabling value-based increment of a metadata, the administrator can create a unique number based on one or more other reference metadata.<\/p>\n\n<p>For example, it is possible to generate a different and independent numbering per customer if the selected reference metadata is for example <em>the &#8220;Customer reference&#8221;.<\/em> It is also possible to combine multiple metadata. In this case, the numbering will be different and independent by combining values from the selected metadata.<\/p>\n\n<figure class=\"wp-block-image size-large\"><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/image-10_AUTO-translated-1024x242.png\" alt=\"\" class=\"wp-image-13206\"\/><figcaption>On the left, a numbering depending on the <em>&#8220;Customer Reference&#8221;<\/em> metadata. On the right, a numbering depending on the metadata &#8221; <em>Customer reference<\/em> &#8221; AND &#8220;<em>Document type&#8221;<\/em><\/figcaption><\/figure>\n\n<p><strong>Example<\/strong><\/p>\n\n<p>One user adds:<\/p>\n\n<ul class=\"wp-block-list\"><li>4 documents with the customer reference &#8221; <em>ref01<\/em> &#8221; and type &#8221; <em>Invoice&#8221;<\/em><\/li><li>3 documents with the customer reference &#8221; <em>ref01<\/em> &#8221; and type &#8221; <em>Contract&#8221;<\/em><\/li><li>2 documents with the customer reference &#8221; <em>ref02<\/em> &#8221; and type &#8221; <em>Invoice&#8221;<\/em><\/li><\/ul>\n\n<p>Depending on the setting on the left, the current value of the auto increment is:<\/p>\n\n<ul class=\"wp-block-list\"><li>7 for customer reference &#8221; <em>ref01&#8243;<\/em><\/li><li>2 for customer reference &#8221; <em>ref02&#8243;<\/em><\/li><\/ul>\n\n<p>Depending on the setting on the right, the current value of the auto increment is:<\/p>\n\n<ul class=\"wp-block-list\"><li>4 for customer reference &#8221; <em>ref01<\/em> &#8221; and type &#8221; <em>Invoice&#8221;<\/em><\/li><li>3 for customer reference &#8221; <em>ref01<\/em> &#8221; and type &#8221; <em>Contract&#8221;<\/em><\/li><li>2 for the customer reference &#8221; <em>ref02<\/em> &#8221; and type &#8221; <em>Invoice&#8221;<\/em><\/li><\/ul>\n\n<p><\/p>\n\n<p><\/p>\n\n<h2 class=\"wp-block-heading\">Auto-increment metadata calculation<\/h2>\n\n<p>The auto-incremental metadata value is calculated at two points in a document&#8217;s lifecycle in Open Bee\u2122 Portal.<\/p>\n\n<ul class=\"wp-block-list\"><li>Filing the document<ul><li>Adding the document<\/li><li>Editing the document to change the filing rule associated with the document<\/li><\/ul><\/li><\/ul>\n\n<p><\/p>\n\n<ul class=\"wp-block-list\"><li>When changing a value in one of the reference metadata<\/li><\/ul>\n\n<p><\/p>\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p>Be careful, when one of the reference metadata is modified, the auto increment is automatically recalculated to ensure its uniqueness. The value that will be assigned to it is the next available value. There is no recalculation of documents that have already been filed.<\/p><\/blockquote>\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p>Changing the reference metadata of a document has the same behavior as deleting the document and adding it again with the new metadata value.<\/p><\/blockquote>\n\n<p><\/p>\n\n<h2 class=\"wp-block-heading\">Changing the configuration of auto-incremental metadata<\/h2>\n\n<p>When the administrator changes the configuration of an auto-increment metadata that is already in use, it is important to note the following behaviors:<\/p>\n\n<ul class=\"wp-block-list\"><li><strong>Changing the Initial Value<\/strong><\/li><\/ul>\n\n<p>This change will be taken into effect as soon as a condition allows the metadata to be reset auto-increment. It should be noted that if no reset condition is set, changing the initial value has no impact once the first document has been filed.  <\/p>\n\n<ul class=\"wp-block-list\"><li><strong>Modification of the conditions for the return to the original value<\/strong><\/li><\/ul>\n\n<p>The administrator can change the conditions for resetting the metadata at any time. Changing the conditions does not reset the metadata. This will be returned to its original value when the first condition is met.<\/p>\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p>Example: On a Monday, the administrator changes the original value discount condition to &#8220;Every Monday&#8221;. The next reset will take place the following Monday.<\/p><\/blockquote>\n\n<ul class=\"wp-block-list\"><li><strong>Changing the increment by a metadata value<\/strong><\/li><\/ul>\n\n<p><strong>Careful:<\/strong> Changing the metadata references auto increment automatically resets the metadata to the original value of the metadata. It is no longer possible to guarantee uniqueness.  <\/p>\n\n<p>It is considered that modifying the reference metadata is the same as creating a new numbering.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Since version 6.13.0 of Open Bee\u2122 Portal a new type of metadata has been added, it is the auto increment type. The auto-increment metadata type is used to calculate a unique number. Compared to the old auto-increment mechanism that existed in previous versions, this new type brings two additional features: Periodic metadata reset A different [&hellip;]<\/p>\n","protected":false},"author":95,"featured_media":0,"parent":20459,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-20472","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/20472","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\/95"}],"replies":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/comments?post=20472"}],"version-history":[{"count":2,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/20472\/revisions"}],"predecessor-version":[{"id":38748,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/20472\/revisions\/38748"}],"up":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/20459"}],"wp:attachment":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/media?parent=20472"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}