{"id":21055,"date":"2022-04-11T13:55:48","date_gmt":"2022-04-11T11:55:48","guid":{"rendered":"https:\/\/help.openbee.com\/open-bee-scan-capture\/administrators-guide\/accounting\/setting-up-the-accounting-export\/file-export\/"},"modified":"2022-04-11T13:55:48","modified_gmt":"2022-04-11T11:55:48","slug":"file-export","status":"publish","type":"page","link":"https:\/\/help.openbee.com\/en\/open-bee-scan-capture\/administrators-guide\/accounting\/setting-up-the-accounting-export\/file-export\/","title":{"rendered":"File export"},"content":{"rendered":"
\n

File export is suitable for most applications. A text file is generated from the lines of entries made. This file will be saved by the console on the user’s computer when exporting each batch.<\/p>\n

The file export configuration interface is composed of two main sections:<\/p>\n

    \n
  1. Export file<\/strong> : This part deals with the shape of the generated file.<\/li>\n
  2. Template<\/strong> : Allows you to define the structure of the contents of the exported file.<\/li>\n<\/ol>\n

    <\/h1>\n

    Export file<\/h1>\n

    This part deals with the shape of the generated file. It allows you to name the file, encode it, and drop it to a specific location.<\/p>\n

    <\/p>\n

    File Path<\/h2>\n

    The file path is used to define the location of the file generated by Open Bee\u2122 Scan Capture. When exporting a batch, the file will be placed directly in that location.
    \nIn case this value is empty, a window will then ask the user where to export the file generated when exporting the batch.<\/p>\n

    \n
    \n

    The path entered will be configured only for the user of the current Windows session.<\/p>\n<\/div>\n<\/div>\n

    File Name<\/h2>\n

    The name of the file is free, but it must be followed by the desired extension. If this is not the case, a file without an extension will be generated.<\/p>\n

    Encoding<\/h2>\n

    Encoding is used in very special cases to improve the handling of special characters. If no encoding is selected, the system encoding will be applied.<\/p>\n

    Compression<\/h2>\n

    The compression option allows you to zip the export file with the relevant PDF documents for it.<\/p>\n

    Working with Variables<\/span><\/p>\n

    It is possible to insert variables specific to Open Bee\u2122 Scan Capture in the file name or path. To display the list of available variables, simply use the “%” character with the cursor in one of these fields. The variables available depend on the batch or folder concerned by the export, in fact several documents can be exported simultaneously, so it is not possible to use a particular variable present on one of them for the name or path of the file.<\/p>\n

    <\/p>\n

    Model<\/h1>\n

    For more information on how to configure the Mustache model, you can consult the Mustache model<\/a> page<\/p>\n

    Pre-built tags<\/h4>\n

    These tags are pre-integrated into Open Bee\u2122 Scan Capture to allow it to iterate over certain objects and therefore allow the construction of the output file:<\/p>\n

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Variable<\/th>\nContext<\/th>\nUse<\/th>\nOpen Bee\u2122 Scan Capture version<\/th>\n<\/tr>\n
    vatAccounts<\/td>\n<\/td>\nAllows you to iterate on VAT accounts<\/td>\n2.4.1<\/td>\n<\/tr>\n
    simpleAccounts<\/td>\n<\/td>\nAllows you to iterate on expense accounts<\/td>\n2.4.1<\/td>\n<\/tr>\n
    personalAccounts<\/td>\n<\/td>\nAllows you to iterate on third-party accounts<\/td>\n2.4.1<\/td>\n<\/tr>\n
    accountEntries<\/td>\n<\/td>\nAllows you to iterate over ledger entry lines<\/td>\n2.4.1<\/td>\n<\/tr>\n
    analyticalBreakDownLines<\/td>\naccountEntries<\/strong><\/td>\nAllows you to iterate over analytical breakdown lines<\/td>\n2.4.1<\/td>\n<\/tr>\n
    analyticalBreakDownLines_x<\/td>\naccountEntries<\/strong><\/td>\nx = the number representing the index of the analytical breakdown line. 1<=X<Infinity<\/span><\/td>\n3.4.4<\/td>\n<\/tr>\n
    isImported<\/td>\nvatAccounts, simpleAccounts, personalAccounts<\/strong><\/td>\nAllows you to test whether or not an account has been imported<\/td>\n2.4.1<\/td>\n<\/tr>\n
    isReferenced<\/td>\nvatAccounts, simpleAccounts, personalAccounts<\/strong><\/td>\nAllows you to test whether the account is referenced in the entries located in the accountEntries tag<\/td>\n2.4.1<\/td>\n<\/tr>\n
    isClient<\/td>\npersonalAccounts<\/strong><\/strong><\/td>\nAllows you to test whether the third-party account is a customer account<\/td>\n2.6.3<\/td>\n<\/tr>\n
    isSupplier<\/td>\npersonalAccounts<\/strong><\/strong><\/td>\nAllows you to test whether the third-party account is a vendor account<\/td>\n2.6.3<\/td>\n<\/tr>\n
    isVATLine<\/td>\naccountEntries<\/strong><\/strong><\/td>\nAllows you to test whether the entry line contains a VAT account<\/td>\n2.7.1<\/td>\n<\/tr>\n
    isPersonalLine<\/td>\naccountEntries<\/strong><\/strong><\/td>\nAllows you to test whether the entry line contains a third-party account<\/td>\n2.7.1<\/td>\n<\/tr>\n
    isClientLine<\/td>\naccountEntries<\/strong><\/strong><\/td>\nAllows you to test whether the entry line contains a customer account<\/td>\n2.7.1<\/td>\n<\/tr>\n
    isSupplierLine<\/td>\naccountEntries<\/strong><\/strong><\/td>\nAllows you to test whether the entry line contains a vendor account<\/td>\n2.7.1<\/td>\n<\/tr>\n
    isChargeLine<\/td>\naccountEntries<\/strong><\/strong><\/td>\nAllows you to test whether the entry line contains a load account<\/td>\n2.7.1<\/td>\n<\/tr>\n
    HasAnalyticalBreakdown<\/span><\/td>\naccountEntries<\/strong><\/strong><\/td>\n{{#….}} Allows you to test whether the write line has analytics OR {{…}} to get the number of analytic lines for a write line<\/td>\n{{#….}} 3.1.0 AND {{…}} 3.4.4<\/td>\n<\/tr>\n
    isFirstAccountEntryLine<\/span><\/td>\naccountEntries<\/strong><\/strong><\/td>\nAllows you to test whether the entry line is the first of the entry lines associated with the current document<\/td>\n3.2.1<\/td>\n<\/tr>\n
    isLastAccountEntryLine<\/span><\/td>\naccountEntries<\/strong><\/strong><\/td>\nAllows you to test whether the entry line is the last of the entry lines associated with the current document<\/td>\n3.3.0<\/td>\n<\/tr>\n
    VAT_<\/strong>VariableName<\/td>\naccountEntries<\/strong><\/strong><\/td>\nAllows you to obtain information about a variable in the VAT account associated with the current line<\/p>\n

    Example<\/u>: On a load line {{accountNumber}} vous permettra d'acc\u00e9der au num\u00e9ro du compte de charge alors que {{VAT_accountNumber}} vous permettra d'acc\u00e9der au num\u00e9ro du compte de TVA li\u00e9 \u00e0 cette ligne.<\/code><\/em><\/td>\n

    		3.4.0<\/td>\n<\/tr>\n
    VariableName_sum<\/strong><\/td>\n<\/td>\nAllows you to get the sum of the variables of an index included in a groupExample<\/u>: {{HT_1}} permet d'obtenir la 1er valeur de HT alors que {{HT_sum}} permettra d'obtenir la somme des montants HT.<\/code><\/em><\/td>\n4.4.0<\/td>\n<\/tr>\n
    VariableName_current<\/strong><\/td>\n<\/td>\nRetrieves the variable corresponding to the idUnit in relation to the current entry line<\/p>\n

    Example<\/u>: Je veux obtenir un montant de TVA particulier, je nomme donc ma variable {{MontantTVA_current}}. Si la ligne courante est une ligne d'\u00e9criture avec le montant HT, Capture retrouvera donc l'idUnit correspondant au montant HT de cette ligne, puis se servira de cet idUnit pour l'appliquer \u00e0 votre variable<\/code><\/em><\/td>\n

    		4.4.0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

    Tags that have a context can only be used within the context.<\/p>\n

    Example: The analyticalBreakDownLines tag can only be used inside accountEntries tags<\/p>\n

    Encoding problem on a variable<\/strong><\/p>\n

    When a final value contains a special character, it can happen that the character is incorrectly encoded.
    \nTo write the raw value and avoid encoding problems, you can use the & <\/strong>character in your variable.
    \nEx {{tiers}} becomes {{&tier<\/strong>}}<\/em><\/p>\n

    Additional Information Variables (Available in version 3.4.0) <\/strong><\/h4>\n

    Additional information variables are used like this:<\/p>\n

    1) Choose the source “Additional Information” from the list available for a new variable and then name your variable<\/p>\n

    2) Use your variable like any other, but followed by “_CleDeLinformationSupplementaireVoulue”.<\/p>\n

    Example<\/u>:<\/em><\/p>\n

      \n
    • Specified variable name: InfoLib<\/em><\/li>\n
    • Key to the additional information required: PROFILTVA<\/em><\/li>\n
    • rendered in template text: {{infoLib_TVAprofile<\/em>}}<\/em><\/li>\n<\/ul>\n
      \n
      \n

      Be careful, the additional information key is case-sensitive. It is therefore necessary to have the same capital letters as those present in the key of the information<\/p>\n<\/div>\n<\/div>\n

      Pre-set exports<\/h4>\n

      Some formats are integrated as soon as Open Bee\u2122 Scan Capture is installed and are almost ready to use. However, some templates contain tags enclosed in square brackets “[]”. This is the case for [MY_CODE_EXPERT] and in [MY_NUMERO_DOSSIER] the following example:<\/p>\n

      <\/p>\n

      These variables indicate that a value is required at that location. These are elements that should be replaced by variables, or fixed values, when setting up Open Bee\u2122 Scan Capture.<\/p>\n

      <\/span><\/div>\n<\/div>\n

      <\/p>\n

      <\/p>\n","protected":false},"excerpt":{"rendered":"

      File export is suitable for most applications. A text file is generated from the lines of entries made. This file will be saved by the console on the user’s computer when exporting each batch. The file export configuration interface is composed of two main sections: Export file : This part deals with the shape of […]<\/p>\n","protected":false},"author":97,"featured_media":0,"parent":21011,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"templates\/ob-help-products.php","meta":{"footnotes":""},"class_list":["post-21055","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21055","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\/97"}],"replies":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/comments?post=21055"}],"version-history":[{"count":0,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21055\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21011"}],"wp:attachment":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/media?parent=21055"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}