Skip to main content

Changelog

All notable changes to this project will be documented in this file.

info

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

You can read the Microsoft help if you want to update your Excel Importer app to the latest version and are not sure how to do this. We have also created this animation to show you how.

Important
  • Do not update apps while users are working, as it can cause a disruption and loss of work.
  • It is always best to install updates in a Sandbox first and test them to ensure no adverse effects.

5.0.4.0

Changed

  • Some additional functions have been made public to allow developers to perform better error handling when extending the File Importer feature. We also updated the documentation here.

5.0.3.0 2024-04-18

Changed

  • Added documentation relating to the public functions available on the File Import API. You can read about this here.
  • Added a new Processing Method for imported files so you can elect to process the file manually. This is helpful if you want to delete or move a file on external storage, but only after you are sure the file is saved in Business Central.

5.0.2.0 2024-04-14

Added

  • The app now supports importing Jobs. You can read more about this here.
  • We have made the following enhancements to the File Importer API:
    • You can now configure the Import Definition to only capture distinct errors.
    • The response now includes the first error message and collected errors.
    • We added some example responses in the help.

5.0.1.0 2024-04-06

Changed

  • We updated the online help for the File Import API to include an example on enabling a custom Import Type to be triggered by the API.
  • We Changed some internal functions to public to support extensibility from within an AL extension. We also added an example of how to import file imports using AL. You can read more about this here.

5.0.0.0 2024-04-02

Added

  • The app now includes an API that allows you to automate the process of importing files using the Excel Importer. You can read more about this here.

4.6.15.0 2024-03-18

Fixed

  • Resolved an issue on the Price List import where the app would provide an incorrect error message when updating a price list with a line having a different ending date to the header.

4.6.14.0 2024-03-14

Fixed

  • Resolved an issue that was introduced in 4.6.13.0 where the pre-validation would incorrectly report on missing master data.

4.6.13.0 2024-03-12

Added

  • You can now use Excel Importer to import Employees and Resources. You can read more about this here.

4.6.12.0 2024-03-12

Fixed

Added

4.6.11.0 2024-03-10

Changed

  • We have refactored some of the Price List import features to allow the import to be used in a broader range of scenarios. We have updated the documentation, which you can read here. Note that we are no longer enhancing the old pricing experience but will continue to support it until Microsoft deprecates it. The fundamental changes are:
    • We added the Price List Grouping setting to enable more control over how the app groups prices into price lists, including the option to allow you to decide.
    • We changed the available values for the Expire Other Prices settings as we now allow you to expire at a price list level. Note: This setting is updated to Price Lists when the new extension is installed.
    • The line number field is ignored from the imported file. This value is not meaningful to a user, and the app does not require the line number as it uses the price list line identifiers to find the record.
    • Inactive price lists are excluded from any validation/expiration logic.

4.6.10.0 2024-02-21

Fixed

4.6.9.0 2024-02-01

Fixed

  • Resolved an issue where payment tolerances would not calculate on entries transferred to a different customer when using the customer remittance transfer feature.

Added

  • It is now possible to select whether to transfer entries in summary or detail when using the customer remittance transfer feature. You can update this setting globally or per customer.

Removed

  • Removed deprecated events and functions.

4.6.8.0 2024-01-17

Fixed

  • Resolved an issue where header fields would get ignored if you also concatenated fields.

4.6.7.0 2024-01-15

Added

Changed

  • If you map more than one column to a blob field, the app now uses the Concatenated Value Separator to separate the values instead of only using a space.

4.6.6.0 2023-12-13

Added

  • You can now create or update an Excel Mapping Template using the file you wish to import. The feature allows you to:
    • Specify field mapping while simultaneously viewing the file you wish to import.
    • Apply Transformation and Account/Dimension Mapping and view the impact of this on the file.
    • You can read more about this here.
  • Added actions to change sorting on the mapping lines

Changed

  • The sales and purchase document imports now group the lines by currency to support scenarios where transactions for the same customers have different currencies. Previously this scenario was only supported if you had a document number in the source file. You can find more details about sales here and purchases here.
  • The Transfer to New Customers feature has been enhanced to copy the receipt external document number and payment reference to the entries created against the new customer.

4.6.5.0 2023-12-07

Fixed

  • The Production Order import was using the wrong status when the page had no existing records.

Changed

  • We enhanced the Customer Remittance pre-import validation to check for more types of data errors.

4.6.4.0 2023-11-20

Added

  • Excel Importer can now import values into the Statistical Account Journal. You can read more about this here.

4.6.3.0 2023-11-15

Fixed

  • Resolved an issue with the text file import where a file containing header and detail records always started importing from the second row - even if there were no column headings in the file.

4.6.2.0 2023-11-14

Fixed

  • Resolved an issue on the Customer Remittance Import where an error would be displayed if you still needed to configure a template.

Added

  • It is now possible to import Requisition Lines into the Requisition Worksheet. You can read more about this here.

Changed

  • The sample data that you can download from the Excel Importer Setup Wizard has been changed to a zip file that contains an Excel file and two text files as the sample templates include text file examples.

4.6.1.0 2023-11-04

Added

  • We have added a new video available from within Business Central to show you how to import CSV files. To view the video, search for Product Videos from tell me. Here is a link to the same video.

4.6.0.0 2023-10-31

Added

  • You can now import text files using Excel Importer. The app supports variable-length files (e.g. CSV) and fixed-length files.
  • The app now supports having different record types in one file. You can specify the criteria for identifying headers, footers or detail lines.

Changes

  • We enhanced the Account/Dimension to map up to eight dimensions directly. Previously, it was only possible to directly map Global Dimensions 1 and 2.
  • You can now enter either the field caption or the field id when defining mapping. Previously, you had to enter the field number or select it from the list. If the text you specify resolves to multiple fields, the app displays the possible fields so you can see the correct field.

4.5.6.0 2023-09-02

Added

  • It is now possible to import customers and vendors using Excel Importer. You can read more about this here.

4.5.5.0 2023-08-30

Changed

4.5.4.0 2023-08-23

Added

  • We have added a custom processing action to set the balancing account to the control account for the customer, vendor, bank, employee or fixed asset. This feature would be used only when importing opening balances for a new company. You can read more about this here. We have also included an example here.
  • New event OnCustomJournalProcessCustomValueActionto add custom processing actions when importing journals.

4.5.3.0 2023-08-11

Added

  • The Fixed Asset import now ensures that the FA Posting Group is specified against the FA Depreciation Book. The app will default this value from the FA Subclass on the asset, but you can override this if you include the column in the file.

4.5.2.0 2023-08-04

Added

  • We have added the ability to import text into blob fields. An example of where this can be used is to import text into the work description on Sales Documents. Here's an example of how to do this mapping.

4.5.1.0 2023-07-20

Added

  • Added a new event OnBeforeValidateSettingValuesForSettingType. This event will replaces OnBeforeValidateSettingValueForSettingType because additional parameters were required.

Deprecated

  • Event OnBeforeValidateSettingValueForSettingType will be removed in a future version.

4.5.0.0 2023-07-13

Added

  • Errors relating to invalid dimension values are now part of the collectable errors we introduced in 4.4.4.0.
  • We have added a common setting to all templates that import dimension values to enable the import to create dimension values if they do not exist in Business Central. You can read about this here.

4.4.8.0 2023-07-12

Changed

  • Added filename as a parameter to the OnBeforeModifyOrInsertData and OnBeforeModifyOrInsertData events so that you can keep track of the files you have imported.

4.4.7.0 2023-06-30

Fixed

  • Decimal numbers got parsed incorrectly if you had set your regional settings to German.
  • Resolved an error in the Physical Inventory Journal import where tracking entries would get created with incorrect quantities when the lot was not present in a file.

4.4.6.0 2023-06-14

Changed

  • Account/Dimension Mapping errors are now part of the collectable errors we introduced in 4.4.4.0.
  • Row Filters now get evaluated before applying mapping or transformation and after applying mapping or transformation. The key driver for this change was to prevent mapping errors on lines that the app would otherwise skip.

4.4.5.0 2023-05-25

Added

  • Added a new event called OnClearPhysicalQuantityOnJournalBeforeUpdatePhysQty, which you can use to handle specific logic required when resetting the physical quantity on the Physical Inventory Journal before importing the recording.

4.4.4.0 2023-05-23

Added

  • It is now possible to import a file into the Physical Inventory Journal to update the journal with the actual quantities. You can read more about this here.
  • We have changed the error handling in the app to support collectable errors. This means that if you import a file with errors, you will receive a list of errors instead of stopping when the first error occurs. We have provided information about this here. Note: all new templates now get a common setting to enable/disable this feature. The feature gets enabled by default.
  • We have added a common setting to all templates that let you decide whether to perform validation before importing the data or only while importing the data. You can read about this here.
  • Added new events OnBeforeCheckImportedValuesBeforeUpdate and OnAfterCheckImportedValuesBeforeUpdate that allow you to extend or change the data validation that gets done before importing data.

4.4.3.0 2023-05-02

Added

  • Added SetTextArray and GetTextArray helper functions to Temporary Storage which you can use when extending Excel Importer.
  • Added a sample Item import template

Changed

  • All templates have been updated to support the settings fact box fully. The Settings lines are no longer visible on the Excel Mapping Template Card because you can change all settings on the settings fact box. Read here for information on how to do this.
  • When selecting fields on the Excel Mapping Template Card, the import sequences get defaulted in the sequence of the columns instead of the sequence of the field numbers.

Removed

  • Removed obsolete events and functions.

4.4.2.0 2023-04-12

Added

  • You can now use Excel Importer to import Job Journals. Read here for more information.

4.4.1.0 2023-04-04

Changed

  • Updated the sample templates for Business Central 2023 Wave 1 (V22)

4.4.0.0 2023-04-02

Changed

  • We have updated our Item Journal import to support the new feature in Business Central 2023 Wave 1, where you can update the item tracking details directly in the Item Journal. The app supports batches where you want to edit the tracking details in the journal and batches where you do not want to do this.

4.3.9.0 2023-03-09

Added

4.3.8.0 2023-02-28

Fixed

  • Resolved an issue on the sales order import for items configured to assemble to order where the program would not create the reservation entries correctly.

Added

4.3.7.0 2023-01-23

Fixed

  • Resolved an issue on the Transfer Order import in relation to the item tracking lines.

4.3.6.0 2022-12-05

Added

  • Added translations for Italian, Spanish and Danish

Fixed

  • Resolved an issue where you could not open the Excel Mapping Template page if the app did not recognise a setting.

4.3.5.0 2022-11-29

Fixed

  • Resolved an issue with the Production Order Import where the Refresh Production Order setting was not respected during the import.

4.3.3.0 2022-11-28

Added

  • You can now specify a Row Filter on all Excel Mapping Templates. The Row Filter allows you to specify when the app should import a row or when the app should skip a row. You can read more about this feature here.
  • Added the Import from Excel action the the Job G/L Journal.

Changed

  • Additional variables added to the Event OnBeforeExcludeExcelBufferRowFromImport

Fixed

  • An error could occur when updating the settings for Production Import Mapping Templates where the error would error and say the setting type was invalid. This same error could also get raised during an upgrade.

4.3.2.0 2022-10-27

Added

  • You can now download a sample configuration package in German. The Excel Importer Setup Wizard will default the language based on your user settings, but you can change it if you like.

4.3.1.0 2022-10-24

Fixed

  • Resolved an issue with the Excel Importer Setup Wizard where errors would occur while applying the configuration package. Due to this issue, it was not possible to finish the process. The errors occurred due to validation added to Business Central, which required changes to the configuration package. We have also changed how the configuration package gets applied to handle future unforeseen issues.
  • Resolved an issue with the Fixed Asset Import that would occur when the imported fixed asset number was empty but specified in a template. The app will now assign a fixed asset number as expected when the number provided is not specified.

Changed

  • Upgraded the settings for Fixed Asset Import to enums. You can now change the settings in the settings fact box.
  • Upgraded the settings for General Journal to enums. You can now change the settings in the settings fact box.

Deprecated

4.3.0.0 2022-08-01

Fixed

  • Resolved an issue on the Price List Import where the Amount Type (Defines) was ignored from the file or the constants specified in the template. This is only applicable to Business Central 20.1 and greater.

Changed

  • When you specify a constant value on the Excel Field Mapping, then app now updates the Default Values field to Use Constant if Empty and raises a notification instead of displaying an error.
  • Changed the available fields on the Price List Import to exclude fields that are duplicated in the standard tables.

4.2.3.0 2022-07-22

Fixed

  • Resolved an issue related to Custom Values. If the custom value had dimensions specified and it was used with a sales line that did not already have default dimensions, then the app would not copy the custom value dimensions to the additional sales line.

Added

4.2.2.0 2022-07-05

Changed

  • Sales and Purchase Document Templates created in older versions are now updated with the default settings values if they were not previously specified. This is required because the new features that validate settings combinations now expect all settings values to be specified (even if they are default)

4.2.1.0 2022-06-30

Fixed

  • Resolved an issue with the upgrade of template settings that caused existing templates not to work correctly. This impacted sales and purchase document templates.

Added

  • New OnBeforeGetSettingsValueCSVText Event allows to to specify allowed values for custom settings when you extend Excel Importer

Changed

  • AddToSettingsText, `` function is now available to extensions if you add custom settings

4.2.0.0 (2022-06-14)

Added

  • Transfer Order Import: Excel Importer now allows you to import new transfer orders. You can find more details about this new import type here.
  • Assembly Order Import: Excel Importer now allows you to import new and update existing Assembly documents. You can find more details about this new import type here.
  • New OnInsertCustomTemplateToBuffer event - you can optionally subscribe to this event if you want to specify additional details about a custom import type.
  • New OnBeforeValidateSettingValueForSettingType event - you can optionally subscribe to this event if you want to validate a setting value selected against a setting type.

Changed

  • Updated sample configuration package and sample data to include Transfer Orders and Assembly Orders

Deprecated

  • Event OnBeforeLookupTemplateName is no longer required because we now use the Import Type enum to form the template name.
  • Event OnEnterConstValueForRelatedField is replaced by the new event OnBeforeValidateSettingValueForSettingType.

Removed

  • Various obsolete public functions and events marked with the tag 18.x have now been removed.

4.1.2.0 (2022-05-26)

Fixed

  • Sales and Purchase Documents
    • When changing the document type on a document with a negative total, the sign of the quantity and the unit amount would get reversed under certain conditions.
    • Using the setting Replace Document No. would cause the imported document number to use the same posting number series as the document number series on sales invoices. Note that this issue resulted from changes made in [4.1.1.0].

4.1.1.0 (2022-05-21)

Added

  • Added a new setting called Negative Document Totals for sales and purchase document imports. This allows you to specify how to handle documents when the total value is negative and allows you to Ignore, Skip, Cancel and Change Document Type.
  • New OnFinalizeImportBeforeCommitAndClearTemporaryStorage event - use this to construct a user feedback message before temporary storage gets cleared
  • New OnFinalizeImportAfterCommitAndClearTemporaryStorage event - use this if you want to handle the display of the feedback message. Temporary Storage is cleared at this stage and the changes are committed.
  • New OnBeforeGetCommaSeparatedDimensionFieldIDText event - used to specify the field ids that contain global/shortcut dimensions so that Excel Importer correctly handles the dimension fields on custom templates.

Changed

  • Added support to use a number from the number series when importing Fixed Assets

Deprecated

  • Event OnAfterValidateFieldNumberForDim and OnAfterValidateDimensionCode are deprecated to simplify handing dimension fields for custom templates - replaced by OnBeforeGetCommaSeparatedDimensionFieldIDText.
  • Event OnBeforeShowingSuccessMsg for sales and purchase documents gets replaced OnFinalizeImportBeforeCommitAndClearTemporaryStorage, which can be used for all templates.

4.1.0.0 (2022-05)

Added

  • Assisted Setup: Excel Importer can get configured from Assisted Setup, and we have created a setup guide to assist assist with permission assignment and sample templates.
  • Guided Tours: We have implemented guided tours on several pages to assist with learning
  • Excel Importer Product Videos in Business Central: We have added Excel Importer product videos to Business Central. Currently, there are two videos. We intend to create more in the future.
  • Price List Import: Excel Importer now supports the new Business Central extended pricing. The import significantly reduces the effort required to load sales and purchase prices.
  • Production Order Import: It is now possible to import new or update existing production orders using Excel Importer. More details...
  • Physical Inventory Orders: Excel Importer provides a more flexible way of importing inventory recordings than the standard CSV import/export.
  • Output and Consumption Journals: Some companies initially record shopfloor activity in a different system to Business Central but want to process the inventory transactions in Business Central. If this data is available in Excel, you can now import this using Excel Importer. Both journals use the existing Item Journal Import.
  • Customer Remittance Import - Transferring Customer Remittance Lines: This new feature allows you to move payments to different customers when one entity pays on behalf of other entities. The new feature is part of the existing Customer Remittance Import functionality. More details...
  • Custom Values: Custom Values allow you to map columns from Excel to placeholders when you cannot map the values directly to a field in Business Central. We only have one standard processing action available on Sales and Purchase imports in this release. Your partner can extend this if you have specific requirements.
  • Temporary Storage: This is a single instance codeunit that is initialised at the start of each import as well as at the end. The codeunit supports passing records and saving them to temporary record reference instances. Up to 10 instances are supported for custom templates. You can also use the temporary storage to store up to 10 text lists. The benefit of this change is to reduce the amount of code you need to write when extending Excel Importer. You can use this to keep track of records being imported so that you can do things like:
    • Release all imported sales orders
    • Check that there are no duplicate lines being imported (e.g. on the price import this is used)
    • Initialise values based on the context of where the import is run (e.g. on the Price list import, the page that runs the import defaults Price Type and Source Group)
  • Settings Helper: Introduced a settings helper which reduce the amount of code required to create custom templates when extending Excel Importer. It's used to:
    • Provide a lookup for settings values. The lookup functionality has events that allow the valid values to be shown in a string menu and also allow entirely custom lookup functionality to be provided.
    • Validate partial entry of a settings value
  • Staging Record Reference: A staging record reference is now available on some events. The staging record is populated from the imported fields without running validation. Where this is available, you can use the values in the fields to determine how to process the date being imported. Previously you needed to find the values in the imported field buffer. This record reference is available on new events and is also available on the OnBeforeFindExistingRecord event. Note that if you make changes to this record reference they will be ignored.
  • New OnBeforeExcludeExcelBufferRowFromImport event: you can subscribe to this event to exclude importing data based on date in the Excel Row. For example your spreadsheet may have sub total lines that need to be excluded.
  • New OnBeforeSkipImportOfRecord event: you can subscribe to this event if you want to skip the import of a row based on the values of fields. This event includes the staging record reference.

Changed

  • Enums instead of hard coded text values: Introduced extensible enums for settings and import types. This replaces the previous method of having hardcoded values. It is backwards compatible with the old method but the old methods will be deprecated.
  • Changed OnBeforeFindExistingRecord event: This event is used if you want to add values to the imported fields before finding a record. Additional parameters have been added to this event to simplify the logic when doing this.

3.2.0.0 (2022-02)

Changed

  • Enums and Options: The logic to evaluate an option field has been enhanced to better support scenarios where only part of the option/enum text value are provided.

Fixed

  • Sales and Purchase Document Imports: In some cases it was not possible to select a purchase or sales header field on a template even though it was available for selection. The issue that was causing this has been resolved.
  • Item Imports:
    • An error would occur if you specified the base unit of measure when importing items. This issue is resolved.
    • You can now apply templates to items when importing. This relies on the new templates feature being enabled.

3.1.1.0 (2021-12)

Added

  • Added an Import from Excel action to Intercompany General Journal

3.1.0.0 (2021-10)

Fixed

  • Updated permission sets to address permission issues that users experienced with the remittance advice import.

3.0.0.0 (2021-09)

Added

  • Warehouse Journal Import: If you have a location set up for directed picks and putaways, you can now use Excel Importer to import Warehouse Item Journals and Warehouse Reclassification Journals.
  • Import purchase quotes, sales quotes, sales return orders, purchase return orders: Added an Import from Excel action to the lists of the above sales and purchase document types.
  • Import Dimension Values: Added an Import from Excel action to the Dimensions page.

Changed

  • Permission Sets: The permission sets for Excel Importer are defined using the new permission set objects. The permission sets got renamed during this process. When the app gets upgraded, the permission assignments to user groups and users are updated to reference the new names. The actual permissions granted have not changed.

Fixed

  • Option/Enum values get tested when entered as a constant value on a related field
  • Resolved an issue with dimension mapping that occurred when a dimension already defaulted

2.1.0.1 (2021-03)

Changed

  • Journal Imports to call the SetupNewLine functions for General Journal Line, Item Journal Line, and FA Journal Line tables to support Business Central defaults such as numbering and default reason codes. By introducing this change, there is a possibility that some fields may default from the batch which was previously not defaulting. Where this causes an issue, the fields can get added to the template with constant values to assign different values.

Fixed

  • Excel sheet name got truncated to 30 characters. The Excel maximum of 31 characters is now supported.

1.0.3.6 (2020-10)

Added

  • Added a feature that allows you to import a customer remittance advice and perform automatic matching to open customer ledger entries.