Fields

Connector will automatically generate the necesary Litium field definitions and assign them to Litium field groups and templates, according to the inRiver model.

If a field already exists in Litium, it will NOT be modified or deleted, but their translations are updated.

The reason for not modifying an existing field (except translations) is to have stability in the web site, where programmers may have hardcoded the field types and their respective field groups into templates.

Corresponding Litium field types to inRiver field datatypes

The fields are mapped according to the following scheme.

Changing field type mappings

The mappings are maintained in the \<Integration folder>\InRiveLitiumIntegration\Model\FieldTypeSettings.xml file.

This file is auto-generated if missing, at the time the connector starts.

For each fieldType in inRiver an xml element will be generated as follows; (the values in following example are only descriptions for what each value means)

<FieldTypeSetting>
    <FieldTypeId>inRiverFieldTypeId</FieldTypeId>
    <Exclude>exclude the field type getting exported.</Exclude>
    <FieldDefinitionName>LitiumFieldDefinitionName</FieldDefinitionName>
    <FieldGroup>LitiumFieldGroup</FieldGroup>
    <FieldDefinitionType>LitiumFieldDefinitionType</FieldDefinitionType>
    <CanBeGridFilter>if true, can be grid filter in Litium</CanBeGridFilter>
    <SortIndex>Litium sort index</SortIndex>
    <CanBeGridColumn>if true, can be grid column in Litium</CanBeGridColumn>
  </FieldTypeSetting>

Note:

• You do not need to do anything, if it is adding a CVL value or its translations, they will be update in Litium automatically. However, if you are adding CVL field itself, you may need to follow following steps.
• You only need following steps, only if you want a different behaviour than the default behaviour to a certian field type.

To change a setting

1. Configure the inRiver model first, according to your business requirements.
2. Stop the Litium wesite, to avoid applying the model to Litium before your changes. If you are using Ftp transfer, stop the Ftp program.
3. Restart the inRiver connect service, the FieldTypeSettings.xml will be updated with any new information from the model.
4. A model file is generated and instruction sync command will also be generated when connect service is re-started. To avoid these changes getting applied to Litium (before your custom configurations), delete the generated sync command xml file from \InRiverLitiumIntegration\SyncCommands. If you are using Ftp transfer delete the generated  zip packages from InRiverLitiumIntegration\FtpPickUp or InRiverLitiumIntegration\SendToFtpQueue folders.
5. Edit the FieldTypeSettings.xml according to your requirements.
6. Restart the inRiver Connect service. This will course the model mapping file to be updated., and necessary sync command files will be generated.
7. Start the Litium web server, (or Ftp program)

Multi-language support

inRiver locale string fields will set the Litium multi-language flag to true.

Default language

Litium supports multi-language for all its field types, but inRiver only supports it for text strings. A possible data loss occurs if Litium field type is multi-language and inRiver field type is not, for example, if a date field in Litium is multi-language, you will only recieve the date in the corresponding default language set in inRiver.

Mapping to Litium field definition

Renaming

Generated Litium field definition id can be changed by changing "FieldDefinitionName" attribute in FieldTypeSettings.xml

In following example, BundleArtNr is re-mapped to Litium as ArticleNo field.

<FieldTypeId>BundleArtNr</FieldTypeId>
    <Exclude>false</Exclude>
    <FieldDefinitionName>ArticleNo</FieldDefinitionName>
    <FieldGroup>General</FieldGroup>
    <FieldDefinitionType>Text</FieldDefinitionType>
    <CanBeGridFilter>true</CanBeGridFilter>
    <SortIndex>5</SortIndex>
    <CanBeGridColumn>true</CanBeGridColumn>

Mapping multiple inRiver fields to a single Litium field

You can map multiple inRiver field types from different inRiver entities to the same field definition in Litium. To avoid inconsistancies and errors, make sure all other settings such as FieldDefinitionType, FieldGroup, SortIndex, etc.., are identical, as shown in below example.

In following example, two different inRiver field types BundleArtNr (in inRiver entity Bundle) and ItemArtNo (in inRiver entity Item) are mapped to the same Litium field definition id ArticleNo.

<FieldTypeId>BundleArtNr</FieldTypeId>
    <Exclude>false</Exclude>
    <FieldDefinitionName>ArticleNo</FieldDefinitionName>
    <FieldGroup>General</FieldGroup>
    <FieldDefinitionType>Text</FieldDefinitionType>
    <CanBeGridFilter>true</CanBeGridFilter>
    <SortIndex>5</SortIndex>
    <CanBeGridColumn>true</CanBeGridColumn>

<FieldTypeId>ItemArtNr</FieldTypeId>
    <Exclude>false</Exclude>
    <FieldDefinitionName>ArticleNo</FieldDefinitionName>
    <FieldGroup>General</FieldGroup>
    <FieldDefinitionType>Text</FieldDefinitionType>
    <CanBeGridFilter>true</CanBeGridFilter>
    <SortIndex>5</SortIndex>
    <CanBeGridColumn>true</CanBeGridColumn>

Changing field definition field type

Set the FieldDefinitionType to one of the following settings.

Following example sets channelName to be a LimitedText field.

<FieldTypeSetting>
    <FieldTypeId>ChannelName</FieldTypeId>
    <Exclude>false</Exclude>
    <FieldDefinitionName>ChannelName</FieldDefinitionName>
    <FieldGroup>General</FieldGroup>
    <FieldDefinitionType>LimitedText</FieldDefinitionType>
    <CanBeGridFilter>true</CanBeGridFilter>
    <SortIndex>0</SortIndex>
    <CanBeGridColumn>true</CanBeGridColumn>
  </FieldTypeSetting>

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 and its data are not exported.

Example:

<FieldTypeSetting>
    <FieldTypeId>FaqAIngress</FieldTypeId>
    <Exclude>true</Exclude>
    <FieldDefinitionName>FaqAIngress</FieldDefinitionName>
    <FieldGroup>General</FieldGroup>
    <FieldDefinitionType>Text</FieldDefinitionType>
    <CanBeGridFilter>true</CanBeGridFilter>
    <SortIndex>0</SortIndex>
    <CanBeGridColumn>true</CanBeGridColumn>
  </FieldTypeSetting>

Litium Field Group

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

Example:

<FieldTypeSetting>
    <FieldTypeId>FaqAIngress</FieldTypeId>
    <Exclude>false</Exclude>
    <FieldDefinitionName>FaqAIngress</FieldDefinitionName>
    <FieldGroup>General</FieldGroup>
    <FieldDefinitionType>Text</FieldDefinitionType>
    <CanBeGridFilter>true</CanBeGridFilter>
    <SortIndex>0</SortIndex>
    <CanBeGridColumn>true</CanBeGridColumn>
  </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>FaqAIngress</FieldTypeId>
    <Exclude>false</Exclude>
    <FieldDefinitionName>FaqAIngress</FieldDefinitionName>
    <FieldGroup>General</FieldGroup>
    <FieldDefinitionType>Text</FieldDefinitionType>
    <CanBeGridFilter>true</CanBeGridFilter>
    <SortIndex>7</SortIndex>
    <CanBeGridColumn>true</CanBeGridColumn>
  </FieldTypeSetting>

inRiver CVL Fields

inRiver CVL fields are mapped as TextOption fields in Litium.

When a CVL value is added or its translation changed in model tool, corresponding Litium value is automatically updated. (You do not have to do anything that is normally required when changing model)