Install the Litium Studio inRiver Connector

Supported versions:

InRiver Connector 2.0

1. Litium Studio 4.6.2 with latest hotfix.
2. inRiver 5.3 with inRiver Connect module.

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 getting started section, or attend the Litium Studio education.

Step 0:

1. Install Litium Studio 462 latest version, or upgrade your existing version to the latest hotfix. Make sure the website is working properly. More on installing Litium Studio >>
2. Aquire an account from inRiver to login to wiki.inriver.com. You need the account to obtain the inRiver installation files and instructions.
3. Install inRiver 5.3 or upgrade to it.
4. Install inRiver Connect 5.3 if it is not already installed. (if you download the full installation bundle, inRiver connect is included with it)
5. Install inRiver standard output (only for verfication purposes), and verify that changes done through rich client is written to the standard output.

Step 1: Copy files to inRiver

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)

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 running.

Login to inRiver admin site, and go to the inRiver Connect page and add the Litium Studio inRiver Connector.

Click on the connector settings to configure the connector and put the ChannelId (that you wrote down in the previous step) and the Integration folder name.

The integration folder name must be a sub folder of your shared integration directory named "InRiverStudioIntegration".

Step 7: Start the Litium Studio inRiver Connector

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.

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

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.

1. 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.
2. 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.

Log inRiver connector (version 2.0) messages to a seperate log file in Litium Studio 4.6.2

It is easy for debugging if you log the inRiver messages to a seperate log file in Litium Studio. To log to a seperate file, add the following into your Litium Studio web.config   <log4net> section.

<log4net>

<appender name="LitiumStudioInRiverLog" type="log4net.Appender.RollingFileAppender">
      <file value="..\litiumstudioInriver.log"/>
      <appendToFile value="true"/>
      <rollingStyle value="Size"/>
      <maxSizeRollBackups value="10"/>
      <maximumFileSize value="10MB"/>
      <staticLogFileName value="true"/>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%-5thread] %-5level %logger - %message%newline"/>
      </layout>
    <filter type="log4net.Filter.LoggerMatchFilter">
     <loggerToMatch value="Litium.Studio.AddOns.InRiver.Integration.Import.SyncCommandRunner" />
     <acceptOnMatch value="true" />
    </filter>
     <filter type="log4net.Filter.DenyAllFilter"/>
</appender>

<root>
      <level value="INFO"/>
     <appender-ref ref="LitiumStudioInRiverLog" />
 </root>

</log4net>