Create related product type field for product types using the API

Title

URL Name

Create-related-product-type-field-for-product-types-using-the-API

Article Number

000184623

Environment

Product: Sitefinity Version: 8.x, 9.x OS: All supported OS versions Database: All supported Microsoft SQL Server versions

Question/Problem Description

How to create a custom related product type field for product types using the API?
How to add a custom related data field of type product type to product types.
How to add a custom related data field to a product type (e.g. to General Product type) and the custom related data field to be of type product type (e.g. General product type) so that when creating a product of type General product to be bale to select and relate to this product other products of type General product or of any other product type (Software, Song).

Steps to Reproduce

Clarifying Information

Error Message

Defect Number

Enhancement Number

Cause

Resolution

The below sample demonstrates how to add a related data field of type General product to the General product type:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using Telerik.Sitefinity.Ecommerce.Catalog.Model;
using Telerik.Sitefinity.GenericContent.Model;
using Telerik.Sitefinity.Model;
using Telerik.Sitefinity.ModuleEditor.Web.Services.Model;
using Telerik.Sitefinity.Modules.Ecommerce.Catalog.Web.UI;
using Telerik.Sitefinity.Modules.Ecommerce.Common;
using Telerik.Sitefinity.Modules.Libraries;
using Telerik.Sitefinity.Modules.News;
using Telerik.Sitefinity.Services;
using Telerik.Sitefinity.Utilities.TypeConverters;
using Telerik.Sitefinity.Web.UI.Fields;

namespace SitefinityWebApp
{
    public partial class CreateRelatedDataFieldProductType : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            var relationFieldName = "RelatedProductTypeFieldName";
            this.AddRelatedDataFieldToContext("General product",
            new Dictionary<string, string>()
            {
                {relationFieldName, string.Empty },

            });
        }

        private void AddRelatedDataFieldToContext(string productTypeTitle, Dictionary<string, string> relatedFields)
        {
            EcommerceManager catalogManager = EcommerceManager.GetManager();

            ProductType productType = catalogManager.GetProductTypes().Where(x => x.Title == productTypeTitle).SingleOrDefault();
            Type productClrType = TypeResolutionService.ResolveType(productType.ClrType);

            if (productClrType == null)
            {
                throw new Exception(string.Format("{0} type can't be resolved.", productClrType.FullName));
            }

            var cfContext = new CustomFieldsContext(productClrType);
            var relatedDataFields = new Dictionary<string, WcfField>();
            UserFriendlyDataType userFriendlyDataType = UserFriendlyDataType.RelatedData;
            foreach (var relatedField in relatedFields)
            {
                var field = new WcfField()
                {
                    Name = relatedField.Key,
                    ContentType = productClrType.FullName,
                    FieldTypeKey = userFriendlyDataType.ToString(),
                    IsCustom = true,

                    //Field definition
                    Definition = new WcfFieldDefinition()
                    {
                        Title = relatedField.Key,
                        FieldName = relatedField.Key,
                        FieldType = typeof(RelatedDataField).FullName,
                        AllowMultipleSelection = true,
                        FrontendWidgetTypeName = "inline",
                        RelatedDataProvider = "OpenAccessDataProvider",

                        // Telerik.Sitefinity.DynamicTypes.Model.sf_ec_prdct_generalproduct
                        RelatedDataType = productClrType.FullName,
                        ValidatorDefinition = newTelerik.Sitefinity.Web.UI.Validation.Definitions.ValidatorDefinition()
                    }
                };

                relatedDataFields.Add(relatedField.Key, field);
            }

            cfContext.AddOrUpdateCustomFields(relatedDataFields, productClrType.Name);
            cfContext.SaveChanges();

            SystemManager.RestartApplication(OperationReason.KnownKeys.StaticModulesUpdate);
        }
    }
}

The RelatedDataType property in the above sample defines the type of the related data field. In the above sample it is set to be of type General product. This can be modified by getting the desired product type by its title using the API:

ProductType productType = catalogManager.GetProductTypes().Where(x => x.Title == productTypeTitle).SingleOrDefault();
Type productClrType = TypeResolutionService.ResolveType(productType.ClrType);

Then set the RelatedDataType to the product type full name:

RelatedDataType = productClrType.FullName

The ContentType property in the above sample defines the content type which the related data will be added to. In the above sample it is General product. Modify it to the desired product type:

ContentType = productClrType.FullName

Workaround

Notes

Keyword Phrase

Last Modified Date

8/4/2016 7:52 AM

Create related product type field for product types using the API

Files(0)

Was this article helpful?

Was this article helpful?

Create related product type field for product types using the API

Information

Related Articles