Setup the standard file transfer service

Install the file transfer service

Follow these four steps to install the file transfer zip:

  1. Makesure you have configuration to use Litium Nuget and other pre-requisites to develop.
  2. Extract all files to optional folder on your local machine.
  3. Open and compile Litium.Studio.Integration.File.Transfer.sln file.

Integration import files

The DefaultFileImportBase.cs file is Litium Studio specific and should not be altered in order to avoid future upgrade problems.
If you want to add methods common for all import cs-files they should be added in the FileImportBase.cs which all Import cs-files inherit from.


  • Corresponding folders are automatically generated in Litium when importing Variants, Price lists etc.
  • Folders “Error”, “Archive” and “Ignore” are created automatically as needed.
  • All import files are imported in chronological order.
  • All successfully imported files are saved in the Archive folder (except for media files which are saved in Litium Studio Media Archive)
  • All incomplete files are sent to the “Error” folder
  • All unknown files (for instance price list files that does not have the same name as the price list) are sent to the “Ignore” folder

 Example files are included in the package:


Product data import

The standard product data xml file has a structured format to handle the base products & variants, price and inventory information. All information is in a single structure to correctly handle the import and that the price list integration is not run before the variant integration has been executed. That could cause the information to mis-match between the systems, for example if trying to import prices before the variant has been created.
If you add or delete any element in this file you also need to update the corresponding validation file: ProductDataImport.xsd. The XSD file validates that the xml file is correct when importing. If a file cannot be validated it is sent to the “Error” folder.

If you wish to map media files and articles the media filename must contain article identification. Best practice is to use the variant id as identifier. See examples in the ProductData.xml file in the package.


Pricelist import

The first step, prior to importing pricelists, is to set them up in Litium Studio. If a pricelist has not been created in Litium Studio before importing files it will NOT be created automatically,  Note! The pricelist name must be the same as the filename (excluding extension).

Pricelists are imported as tab-separated text files: Article number (tab) Price (tab) VAT (tab) minQuantity

The example file Pricelist.txt is found in the package.

Stock balance import

The first step, prior to importing stock balance, is to set it up in Litium Studio. If a warehouse has not been created in Litium Studio before importing files it will NOT be created automatically and the files will be sent to the “Ignore” folder.  Note! The warehouse name must be the same as the stock balance filename (excluding extension).

Pricelists are imported as tab-separated text files: Article number (tab) Quantity

The example file Stockbalance.txt is found in the package.

App.Config file settings

Check all of below settings in the App.Config file and make the changes needed.

In AppSettings\value, set the path to the Litium studio Integration Kit folder on your server:

    <appSettings>         <add key="IntegrationDirectory" value=" " />

The ConnectionString should be the same as for your Litium Studio installation:

<connectionStrings>         <add name="FoundationConnectionString" connectionString="Pooling=;User Id=;Password=;Database=;Server="


The Integration service covers four default important tasks:

Product data import - Litium.Integration.Implementation.Imports.ProductDataImport.

MediaArchive import - Litium.Integration.Implementation.Imports.MediaImport

Price list import - Litium.Integration.Implementation.Imports.PriceListImport,

Stock balance import - Litium.Integration.Implementation.Imports.StockBalanceImport


type – full type name for the task responsible for the integration process parameters – not mandatory, can be used to transfer additional data into the task startTime - time to start executing the integration task from service start interval – interval between executing the task

All default integration values can be changed:

Default values

Build the integration service

By rightclicking the Litium.Studio.Integration.Service you build the file transfer service. Correct any errors and if necessary rebuild.

The integration service is now installed.

How to install as a Windows service

If you want to you can set it up as a Windows service running in the background on your server.

How to build custom implementation tasks

The windows service integration kit allows integration process to run for custom import implementation.


Is this page helpful?
Thank you for your feedback!