Detailed instructions on how to install Litium Studio inRiver Connector.
Supported versions:
InRiver Connector 4.x
- Litium Studio 4.8 with latest service release.
- inRiver versions 6.1, 6.2 and 6.3 with inRiver Connect module.
- Litium Accelerator 4 (optional)
Installation
The installation package contains the following folders:
- inRiver AB: contains the .dll files that should be placed in the inRiver outbound connectors folder.
- Web: contains the .dll files and web user controls that should be placed in Litium Studio website.
- Src: source code.
If you are a Litium Studio developer, you should read this article to understand inRiver basic modelling.
If you are a inRiver developer, you should read the Litium Studio developer basic, or attend the Litium Studio education.
Step 0:
- Install Litium Studio 48 latest version, or upgrade your existing version to the latest hotfix. Make sure the website is working properly. More on installing Litium Studio >>
- Aquire an account from inRiver to login to wiki.inriver.com. You need the account to obtain the inRiver installation files and instructions.
- Install inRiver 6 or upgrade to it.
- Install inRiver Connect 6 if it is not already installed. (if you download the full installation bundle, inRiver connect is included with it)
- Import or configure the inRiver model according to your requirements, and makesure inRiver rich client is working properly.
Step 1: Copy files to inRiver
Shutdown the inRiver Connect service. Then, copy the contents of the "<installation files>\inRiver AB" folder into your inRiver installation. The folder structure is set in the installation files, so that you can copy over the <installation location>\inRiver AB folder if you have a default installation. (Stop the "InRiver Connect" service to avoid file locking if you are upgrading)
- If it is a new installation, you need to rename the Litium.Studio.AddOns.InRiver.dll.config.tmpl.exclude file to Litium.Studio.AddOns.InRiver.dll.config.
- If it is an upgrade, you may need to merge changes in Litium.Studio.AddOns.InRiver.dll.config.tmpl.exclude to your settings file.
Step 2: Copy files to Litium Studio
Copy the contents of the "<installation files"\Web folder to your Litium Studio web root folder.
Step 3: Configuring web.config
Add the following settings to Litium Studio web.config file.
<add key="IntegrationDirectory" value="" /> to "appSettings" section,where the value is your shared integration folder path.
Add the start-up connector start-up task to taskSettings\startupTask section.
<startupTask type="Litium.Studio.AddOns.InRiver.Integration.StartUpTask, Litium.Studio.AddOns.InRiver.Integration" parameters="" />
Step 4: Create shared folder
In your integration shared folder, create a sub folder named "InRiverStudioIntegration". Make sure your Litium Studio instance and InRiver instance both have read/write permissions to it. To give read/write permission to IIS, you may need to run the IIS application pool under an account which has folder read/write permissions, or give the IIS application pool user necessary permissions to that folder. See more information.
Step 5: Add the Litium Studio channel and document its system id
Login to inRiver RichClient and create a channel for Litium Studio, go to its details and click the information icon at the top right hand corner and write down its system id.
Step 6: Configuring inRiver Connect
Make sure the inRiver Connect local service is stopped.
Open the \\Program Files\inRiver AB\inRiver Connect\OutboundConnectors\Litium.Studio.AddOns.InRiver.dll.config and configure. The instructions to configure are included in the file itself (or see the Configure section for more detailed explanations).
When changing a configuration setting, always follow the following sequence:
- Stop the inRiver studio outbound connector from inRiver connect admin
- Stop the inRiver connect service
- Do the configuration changes.
- Start the inRiver connect service.
- Start the inRiver studio outbound connector.
The main configuration options that need to be correct before you can start the connector are:
integrationFolder: integration directory physical path. The final sub directory must be named as "InRiverStudioIntegration"
e.g.: "C:\Files\Integration\InRiverStudioIntegration"
channelId: inRiver channel id.
excludeEntityTypeIds: Comma seperated list of entityTypeIds that should not be exported into Litium Studio. When an entity type is excluded,
all of its associated link types are also not exported.
e.g.: "Assortment, Look, Publication, Section, Task, Compliance"
excludeLinkTypeIds: Comma seperated list of LinkTypeIds that should not be exported into Litium Studio.
e.g.: "ItemItem, ResourceResource"
noOfImagesInResourceLinkTypeId: No of images contained in each inRiver link type that connects resources to entities. Format: "<LinkTypeId>:<No of resources>,<LinkTypeId>:<No of resources>"
e:g: "ProductResource:6, ItemResource:6, ChannelNodeResource:1"
resourceFieldNames: Names of the image resource field in Litium Studio when a inRiver resource link type is exported. (format should be as in example below <LinkTypeId>:<Name>).
e.g: "ProductResource:Image, ItemResource:Image, ChannelNodeResource:Image"
resourceFieldGroups: Names of the image resource field groups in Litium Studio when a inRiver resource link type is exported. (format should be as in example below <LinkTypeId>:<Name>).
e.g: "ProductResource:Image, ItemResource:Image, ChannelNodeResource:Image"
Step 7: Start the Litium Studio inRiver Connector
Start the inRiver Connect service.
Login to inRiver admin site, and go to the inRiver Connect page and add the Litium Studio inRiver Connector.
And then start the connector.
If the connector starts successfully, the inRiver outbound connector log (e.g. C:\Program Files\inRiver AB\inRiver Connect\Log\inRiver.Connect.log) will have information similar to the follwoing.
Important! :
The log will contain "------initialization completed successfully------" message (as shown below), when it is fully ready. Depending on the amount of data in the inRiver database, this may take upto 1hr before you see this message.
You should not proceed any further, before this message appears.
If there are errors:
If you get errors in the output above, read the error carefully and determine which configuration setting need to be adjusted.
To adjust a configuration setting,
- Stop the inRiver studio outbound connector from inRiver connect admin
- Stop the inRiver connect service
- Do the change.
- Start the inRiver connect service.
- Start the inRiver studio outbound connector.
Once the connector is started, it will create the model mapping information files in the <integration folder>\InRiverStudioIntegration\Model\ directory as shown below:
Step 8: Import the model to Litium Studio
Important!!! - Following step may change the existing Litium product fields and templates to match the inRiver model file.
Go to the Litium Studio control panel, under Deployment click the Save button on the inRiver Connector.
The property fields and field templates will be created according to the information contained in the <integration folder>\Model\ModelMapping.xml file. You may verify whether the fields and templates are created, by going to Litium Studio control panel > Product Catalog > Fields and templates.
Note: if this step fails with a error message, it can be due to following reasons.
- The model mapping file, <integration folder>\inRiverStudioIntegration\Model\ModelMapping.xml is missing. This file is re-generated when starting the connector as explained in step 7 of this guide.
- IIS does not have permission to the <integration folder>\inRiverStudioIntegration folder. Giving IIS necessary permissions is explained in step 4 of this article.
Step 9: Publish the Litium Studio channel
In the inRiver rich client, publish the Litium Studio channel.
As the channel information is published for the first time, the follooing structure will be created in the integration folder:
Each inRiver entity in the published channel will be placed under the corresponding directory, with their system id as the file name.
Once the files are imported into Litium Studio, you will see the articles, products and assortments created.
Step 10: Verifications and Debug info
All errors are written to the <Integration root>\InRiverStudioIntegration\SyncCommands\ImportErrors folder.
Also you may check the foundation log in Litium Studio, as well as the inRiver connector log for more information.