Fields

The fields are mapped according to the following scheme. The mappings are maintained in the \\<Integration folder>\InRiverStudioIntegration\ConnectorSettings\ConnectorSettings.xml file. This file is auto-generated when the connector is first started up.

To change a setting

1. Edit the \\<Integration folder>\InRiverStudioIntegration\ConnectorSettings\ConnectorSettings.xml as explained below. (The file is not there, let it be created automatically when connector starts for the first time, and then modify).
2. Stop the Litium Studio inRiver outbound connector from inRiver admin website.
3. Restart the inRiver Connect windows service.
4. Start the Litium Studio inRiver outbound connector from inRiver admin website.
5. Makesure the \\<Integration folder>\InRiverStudioIntegration\Model folder is transferd to the Litium Studio server (if you are using ftp transfer)
6. In Litium Studio backoffice, go to control panel deployment and click the save button to import again.
7. If you had done any modification in Litium Studio, that would get overwritten, you will need to do those changes again after clicking install button. Most common changes project might have done are:
   1. changing the display name, display image of article template or product group template in Litium Studio backoffice to something else other than what is set by the connector.
   2. Translation added in Litium Studio backoffice.
   3. Sort order changes (of fields) done in Litium Studio backoffice.
   4. Grouping changes done in Litium Studio backoffice.

Mapping of fields between inRiver and Litium Studio

Multi-language support

Litium Studio flag "multi-language support for value of the field" is set for inRiver Locale String fields.

String fields

Litium Studio has three string types called Text long, Text middle and Text short, while inRiver only have a string field type. Following scheme is used when choosing the Litium Studio field type for inRiver string fields:

1. If the field is marked as display description in inRiver, the Litium Studio field is a text long field.
2. If the field is marked as a "AdvancedTextObject" field in inRiver, the Litium Studio field is a text long field.
3. If the field is explicitely marked with FieldDefinitionType field setting in \\<Integration folder>\InRiverStudioIntegration\ConnectorSettings\ConnectorSettings.xml, the Litium Studio field is defined by this setting (see below)
4. In all other cases, each inRiver string field becomes a text short string in Litium Studio.

inRiver CVL Fields

inRiver CVL fields are mapped as Multivalue/Default value text short fields in Litium Studio. When the field is marked as Multi-Value in inRiver, the value set in Litium Studio is a comma seperated list of the value field.

inRiver does not allow spaces in the CVL key. If you already have a Litium Studio solution with spaces in multivalue/Default value keys, you need to rename them first.

Field data type mapping

The field data types are mapped between inRiver and Litium Studio according to the following scheme.

Converting inRiver fields to text fields in Litium Studio

The connector can be configured to use Litium Studio Text long, Text middle or Text short data type for any of the inRiver field data types by setting "FieldDefinitionType" to "LongText","LongSimpleText" or "Text" respectively in \\<Integration folder>\InRiverStudioIntegration\ConnectorSettings\ConnectorSettings.xml. For example, following image shows how to set a inRiver Locale String field type called ItTeaserText to be treated as a Text long field in Litium Studio.

<FieldTypeSetting>
    <FieldTypeId>ItTeaserText</FieldTypeId>
    <Exclude>false</Exclude>
    <FieldDefinitionName>ItTeaserText</FieldDefinitionName>
    <FieldGroup />
    <FieldDefinitionType>LongText</FieldDefinitionType>
    <Searchable>true</Searchable>
    <SortIndex>0</SortIndex>
    <Internal>false</Internal>
  </FieldTypeSetting>

Renaming field type name

When transfering to Litium Studio, the default field type name generated is same as the inRiver field type id. To rename, use the FieldDefinitionName setting for the field type. Following example renames the ItTeaserText to TeaserText.

<FieldTypeSetting>
    <FieldTypeId>ItTeaserText</FieldTypeId>
    <Exclude>false</Exclude>
    <FieldDefinitionName>TeaserText</FieldDefinitionName>
    <FieldGroup />
    <FieldDefinitionType>LongText</FieldDefinitionType>
    <Searchable>true</Searchable>
    <SortIndex>0</SortIndex>
    <Internal>false</Internal>
  </FieldTypeSetting>

Use this feature with caution, if you have multiple fields with same name, their attributes need to be same, otherwise you may end up with unintended settings in the Litium Studio field and field template.

Excluding field type

A field type can be prevented from getting exported by setting the Exclude attribute. The field will not be created in Litium Studio and its data are not exported.

<FieldTypeSetting>
    <FieldTypeId>ItTeaserText</FieldTypeId>
    <Exclude>true</Exclude>
    <FieldDefinitionName>TeaserText</FieldDefinitionName>
    <FieldGroup />
    <FieldDefinitionType>LongText</FieldDefinitionType>
    <Searchable>true</Searchable>
    <SortIndex>0</SortIndex>
    <Internal>false</Internal>
  </FieldTypeSetting>

Litium Studio Field Group

By default the fields created by inRiver connector has the field group name set to the inRiver Category. However, inRiver does not allow spaces in the field category. To set the field group in Litium Studio to a value other than the inRiver field Category, use the FieldGroup setting for the field type.

<FieldTypeSetting>
    <FieldTypeId>ItTeaserText</FieldTypeId>
    <Exclude>false</Exclude>
    <FieldDefinitionName>TeaserText</FieldDefinitionName>
    <FieldGroup>General </FieldGroup>
    <FieldDefinitionType>LongText</FieldDefinitionType>
    <Searchable>true</Searchable>
    <SortIndex>0</SortIndex>
    <Internal>false</Internal>
  </FieldTypeSetting>

Changing sort order of fields

To change the sort order of the generated fields, use the SortIndex setting for the inRiver field type.

<FieldTypeSetting>
    <FieldTypeId>ItTeaserText</FieldTypeId>
    <Exclude>false</Exclude>
    <FieldDefinitionName>TeaserText</FieldDefinitionName>
    <FieldGroup>General </FieldGroup>
    <FieldDefinitionType>LongText</FieldDefinitionType>
    <Searchable>true</Searchable>
    <SortIndex>0</SortIndex>
    <Internal>false</Internal>
  </FieldTypeSetting>

Set field as internal in Litium Studio

To set a field as internal in Litium Studio, change the Internal setting to true for the field.

<FieldTypeSetting>
    <FieldTypeId>ItTeaserText</FieldTypeId>
    <Exclude>false</Exclude>
    <FieldDefinitionName>TeaserText</FieldDefinitionName>
    <FieldGroup>General </FieldGroup>
    <FieldDefinitionType>LongText</FieldDefinitionType>
    <Searchable>true</Searchable>
    <SortIndex>0</SortIndex>
    <Internal>true</Internal>
  </FieldTypeSetting>