PIMinRiver

inRiver

Retrieve Product Descriptions from inRiver

You can create product descriptions in inRiver, import them to Sana and use them in your Sana web store.

You need to determine which field from inRiver to use as description and then create the inRiver server setting.

Description can be a part of a source entity or a part of the related entities. The structure of the server setting will be different, depending on from which entity you need to pass description to Sana. See the explanation below.

Description is a field from source entity

Step 1: Open the inRiver Product Model. In the Fields section select the field which should be considered as the product description field for Sana. Then you need to find the Field Type Id of the selected field. The value of the Field Type Id field will be used to create a server setting. In this case, the value is ProductLongDescription.

It is recommended to select the field of one of the following field types:

  • String
  • LocaleString

The field of "LocaleString" type is the most suitable, because this field type allows to translate descriptions to multiple languages and then use them in the Sana web store.

Step 2: Go to the Settings in the inRiver Control Center. Create the SANA_PRODUCT_DESCRIPTIONFIELD server setting and add the value of the Field Type Id field to the value of this setting.

The server setting should look in the following way: the key is SANA_PRODUCT_DESCRIPTIONFIELD and the value is ProductLongDescription.

Description is a field from related entity

If you need to retrieve a field not from the source entity, but from the related entity, then the structure of the server setting will be different, more complicated, since you need to specify the full path to the necessary field in the server setting.

For example, the entities you need to retrieve a field from are linked in the following way:

          Source entity: Product
                Inbound entity: ProductDetails (Link Type Id: ProductDetails)
                    Inbound entity: ProductDescription (Link Type Id: ProductDescription)
                         Field: MainProductDescription (Field Type Id: MainProductDescription)

In this case, Product is a source entity, ProductDetails is a related entity linked to the Product source entity, ProductDescription is a related entity linked to the ProductDetails and MainProductDescription is a field from Product Description related entity which will be used as description for a product in Sana.

To create a server setting you need the Link Type Ids of related entities and the Field Type Ids of fields.

Since Product is a source entity, then it will be used to create a key for the server setting: SANA_PRODUCT_DESCRIPTIONFIELD.

To create the value for the server setting, you need to combine the IDs of related entities in the correct order, the way the entities are linked, meaning that you should specify the path to the field which should be retrieved. The IDs should be separated with a period (.). Then, you need to enter the ID of the field you need to retrieve, separating it from the entities (path) with an underscore (_). In this case, the value is: ProductDetails.ProductDescription_MainProductDescription.

The server setting should look in the following way: the key is SANA_PRODUCT_DESCRIPTIONFIELD and the value is ProductDetails.ProductDescription_MainProductDescription.

When the server setting is created, you need to rebuild the product index. Open Sana Admin and click: Tools > Scheduled tasks. Run Rebuild index for the Product import task. Then, refresh the site cache.

If product descriptions are created in the inRiver Enrichment Portal, then after product index is rebuilt, product descriptions from inRiver will be available in the Sana web store.

PIMinRiver