Configure
Basic configuration options for the connector. How to configure the connector to generate appropriate field types and templates, resource fields and product relationships.
The configuration options for the connector is located in two files:
- \Program Files\inRiver AB\inRiver Connect\OutboundConnectors\Litium.AddOns.InRiver.dll.config
- \<Integration folder>\InRiverLitiumIntegration\Model\FieldTypeSettings.xml
Do not change the inRiver model and the FieldTypeSettings.xml file (see below) at the same time. If you want to make changes to the data model, first make them in the inRiver model according to the instructions below, and then change the FieldTypeSettings.xml according to instructions below.
Litium.AddOns.InRiver.dll.config
This file contains the basic configuration options that affect the data generation by the connector. In the Visual studio solution, open the app.config file of the Litium.AddOns.InRiver project. At the begining of this file, there are instructions for all the settings.
Change the settings according to your project and re-build the project. The Litium.AddOns.InRiver.dll.config file will be generated from this app.config file when you build the project.
If you are upgrading from Connect v. 4, find the settings in the file
\Program Files\inRiver AB\inRiver Connect\OutboundConnectors\Litium.Studio.AddOns.InRiver.dll.config and merge the changes into the app.config file.
The following main configuration options need to be correct, otherwise the connector will not start:
- integrationFolder: The physical path to the integration directory. The last subdirectory must be named "InRiverLitiumIntegration", for example "C:\Files\Integration\InRiverLitiumIntegration". This is the subfolder that you created during the initial configuration.
- channelId: The inRiver channel id, this is the id of the Litium channel you created during the initial configuration.
- productDisplayTemplates: The product display template in Litium. This will be created in Litium if it does not already exist.
- productFieldTemplates: The product field template in Litium. This will be created in Litium if it does not already exist.
- categoryFieldTemplates: The category field template in Litium. This will be created in Litium if it does not already exist.
- excludeEntityTypeIds: Comma separated list of entity type id's that should not be exported to Litium. When an entity type is excluded, all of its associated link types are also excluded from the export. Example: "Assortment, Look, Publication, Section, Task, Compliance".
- excludeLinkTypeIds: Comma separated list of link type id's that should not be exported to Litium. Example: "ItemItem, ResourceResource".
- assortmentLinkTypeId: The inRiver LinkTypeId of the links that will be assortments in Litium. The LinkTarget of this link type must be a ChannelNode and will be an assortment in Litium. LinkSource must be a Channel in inRiver.
- categoryLinkTypeIds: The inRiver LinkTypeIds of the links that will be Category-Category links in Litium. The source entity type and target entity type of this link type must be an inRiver ChannelNode.
- baseProductLinkTypeIds: The inRiver LinkTypeId of the links that will be Category-BaseProduct links in Litium. The source entity type of these link types must be an inRiver ChannelNode. The target entity type of these link types will be exported to Liltium as Litium base products.
- variantLinkTypeIds: The inRiver LinkTypeIds of the links that will be BaseProduct-Variant links in Litium. The LinkTarget of these link types will be exported to Litium as Litium variants. The link source of these link types must be Litium base products, as defined in the baseProductLinkTypeIds setting.
FieldTypeSettings.xml
This file is generated the first time the connector is started. It contains the settings for the property fields that will be transfered to Litium.
When the inRiver connector starts on the inRiver server, it will read this file, and use the information when generating the \<integration folder>\inRiverLitiumIntegration\Model\ModelMapping.xml file. This file will be used by Litium to generate the fields and field templates.
Changing configuration options and the inRiver model
Follow these steps when changing the configuration options.
- Wait for any ongoing integration transfer jobs to finish. You can check ongoing exports in any of the following ways:
- Check the \Program Files\inRiver AB\inRiver Connect\Log\inRiver.Connect.log.
- Check if new files are created in the folder \<Integration folder>\InRiverLitiumIntegration\SyncCommands.
- If you use FTP transfer, you can check if new files are added to the folder \<Integration folder>\InRiverLitiumIntegration\SendToFtpQueue and that the \<Integration folder>\InRiverLitiumIntegration\FtpPickUp directory is empty.
- You may check if any imports are ongoing from the Litium backoffice in Products > inRiver Command Queue. The list should be empty. Note that the list is not automatically refreshed, you need to refresh the page manually.
- Stop the inRiver Connect Windows service.
- If you want to make changes to FieldTypeSettings, remove the Litium inRiver connector start-up task from web.config and start the Litium website, which will cause the inRiver importer to not run automatically.
- Make the configuration changes or inRiver model changes (in Model Tool).
- Start the inRiver Connect Windows service. When starting the service any changes to the model will be transfered to Litium automatically, if you have not stopped the automatic import task (step 3 above).
- If you want to make changes to FieldTypeSettings, do the following:
- Delete the sync command files from the \<Integration folder>\InRiverLitiumIntegration\SyncCommands/nobr> folder.
- Stop the inRiver Connect Windows service.
- Change the FieldTypeSettings.xml file.
- Start the inRiver Connect Windows service.
- Add the Litium inRiver connector start-up task that you removed in step 3 above and start the Litium website. This will make the inRiver importer run automatically.
Some configuration changes will take effect when you start working in the Rich Client.
Inriver languages may need to be mapped to Litium languages, this article explain how to configure.
This section explains how fields are mapped from inRiver to Litium Studio and how to configure their names and data types.
This section explains how the display templates and field templates are generated and how to change the corresponding settings.
This section explains how images (and files) are exported from InRiver and Imported into Litium.
According to inRiver recomended practise, the file data type in inRiver should only be used with inRiver resource entity types. Therefore, for all other entity types, the File data type should not be used. The images and files for a entity are connected resource entities through appropriate link types.
inRiver link types that are not part of the normal entity structure (i.e. excluding ChannelNodes and Product-Item-Resource model links) becomes either Bidirectional or Directional links in Litium where appropriate.
This article explains how to create product relationships in Litium using inRiver connector.
This article explains how to export prices from inRiver to Litium.
There is no inbuilt functionality in inRiver to represent prices. However, your ERP system may export the prices as item fields to the inRiver , and they can be imported into Litium through the connector.
This article explains how to configure the connector to change "Publish" tab in Litium variant and categories.
inRiver SKUs are the units by which the ERP system keeps track of items sold. Therefore, they are variants in Litium. This article shows how to define Sku fields for default connector implementation. Projects may extend this functionality based on the merchant and ERP requirements.
product urls are generated from the display names and SEO title and description from item display name and display description. This article explains best practices to adopt.
inRiver connector 5.0 is more streamlined to work with Litium 5 with Accelerator 5. This article explains the configuration steps.
Certain architectural differences in Litium and inRiver may make some data not published in Litium, and inRiver Litium connector has a integrity check scheduled task to detect bad data if present.