Sitecore custom Contact Facet with WFFM

-

In Sitecore by Out of box, we have predefined Facets but most of them are useful for us, but still, due to some client requirement we may need to store different details about the customer to Mongo DB and will be aggregated to Reporting DB.
Facets have these following.
v  Attributes – attributes are an element's subitems. For example, the Address element could contain attributes such as country, state, town or email address. Attributes can be strings, GUIDs, integers, or floating point numbers.
v  Elements – an element is a data structure that contains one or more members or attributes, such as a facet.
v  Dictionaries – A dictionary contains named elements. Each element in a dictionary is identified by a unique key
Let us start creating Custom Facet for the storing customer’s Email, Age, Designation, and Company but the rest like FirstName into the out of Sitecore Facet.
v  In order to create a Facet, we need to first create an Element which holds all Customer properties like Email, Age, Designation, and company.
v  Mark this class with [Serializable] Attribute, it is very important when we using shared session, else it will throw Tracker not initialized error

   public interface IcustomerDetailsElement : IElement
   {
        string Email { get; set; }
        string Company { get; set; }
        string Designation { get; set; }
        int Age { get; set; }
   }

  [Serializable]
    public class CustomerDetailElement : Element, IcustomerDetailsElement
    {
        private const string EMAIL = "Email";
        private const string COMPANY = "Company";
        private const string DESIGNATION = "Designation";
        private const string AGE = "Age";

        public CustomerDetailElement()
        {
            this.EnsureAttribute<string>(COMPANY);
            this.EnsureAttribute<string>(DESIGNATION);
            this.EnsureAttribute<int>(AGE);

        }
        public string Email
        {
            get { return base.GetAttribute<string>(EMAIL); }
            set { base.SetAttribute<string>(EMAIL, value); }
        }
        public int Age
        {
            get { return base.GetAttribute<int>(AGE); }
            set { base.SetAttribute<int>(AGE, value); }
        }

        public string Company
        {
            get { return base.GetAttribute<string>(COMPANY); }
            set { base.SetAttribute<string>(COMPANY, value); }
        }

        public string Designation
        {
            get { return base.GetAttribute<string>(DESIGNATION); }
            set { base.SetAttribute<string>(DESIGNATION, value); }
        }


    }
·         Once we created the element class with necessary fields that we need to store to Mongo DB, now let's create the Facet class.

        IFacet implements IElement Class.
    public interface IContactCommentsFacet : IFacet
    {
        string Comments { get; set; }
        IElementCollection<IcustomerDetailsElement> CustomerDetails { get; }
    }

   [Serializable]
    public class ContactCommentsFacet : Facet, IContactCommentsFacet
    {
        private const string CONTACT_COMMENT = "Comments";
        private const string CUSTOMER_DETAILS = "CustomerDetails";
        public ContactCommentsFacet()
        {
            base.EnsureAttribute<string>(CONTACT_COMMENT);
            base.EnsureCollection<IcustomerDetailsElement>(CUSTOMER_DETAILS);
        }
        public string Comments
        {
            get { return base.GetAttribute<string>(CONTACT_COMMENT); }
            set { base.SetAttribute<string>(CONTACT_COMMENT, value); }
        }

        public IElementCollection<IcustomerDetailsElement> CustomerDetails
        {
            get
            {
                return base.GetCollection<IcustomerDetailsElement>(CUSTOMER_DETAILS);
            }
        }


    }
v  Now our Elements and Facets created now its time to make Sitecore aware of this new Facet.
v  Add the Element and Facet to the Config patch file

Elements
Interface
Implementation
ICustomerDetailsElement
CustomerDetailElement
IContactCommentsFacet
ContactCommentsFacet

Facet
Name
Interface
Contact Details
IContactCommentsFacet



<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
  <sitecore>
    <model>
      <elements>
        <element interface="xxxxxxx.IcustomerDetailsElement, xxxxxxx" implementation="xxxxxxx.CustomerDetailElement, xxxxxxx" />
        <element interface="xxxxxxx.IContactCommentsFacet, xxxxxxx" implementation="xxxxxxx.ContactCommentsFacet, xxxxxxx" />
      </elements>
      <entities>
        <contact>
          <facets>
            <facet name="Contact Details" contract="xxxxxxx.IContactCommentsFacet, xxxxxxx" />
          </facets>
        </contact>
      </entities>
    </model>   
  </sitecore>
</configuration>

Once this step is done, if we go to WFFM form we can see this new Facet shows when updating the Fields.











Comments

Post a Comment

Popular posts from this blog

Custom Item Url and resolving the item in Sitecore - Buckets

-
Image
I have a situation to update the Item URL to be SEO friendly as my items in content tree looks like below. In the above image in order to resolve the item, Sitecore will find the item from the below URL http://domainname/en/dine/nv/chicken but I need to form a URL that is more SEO friendly like http://domainname/en/chicken In Sitecore by Out of box, we can achieve this by using Aliases , we can create an Aliases under System à Aliases and in the Linked Item field select the target item. But this is very tedious as we need to go to every item in the content tree and create Aliases, instead of that we will be going to do it programmatically using custom pipelines. ·          Link Provider (Provides the custom URL for the item based on the templates) ·          Item Resolver (Resolves the item based on the custom URL generated by CustomLinkProvider , that we going to create later. Sitecore could not resolve the item in the specified path in the content tree
Read more

Exploring Sitecore XM Cloud Forms: A Comprehensive Overview

-
Image
  The most awaited news came from Sitecore about the release of XM Cloud Forms.  Previously Sitecore enthusiasts / Marketers used different ways of forms implementation in Sitecore to reach the target customers like WFFM (Web Form For Marketers) Sitecore Forms Embeddable Forms Framework(EFF) XM Cloud Form is the latest addition by Sitecore and especially used to create Forms on XM Cloud pages. It will only work with the latest version of Sitecore JSS (21.6) Note:  I have tried to use XM Cloud Forms in my local docker setup by cloning the starter   repo , but I couldn't see the option of Forms in the XM Cloud dashboard to get started. Lets explore together on the features of Forms. Similar to Sitecore Components, we can navigate to  https://forms.sitecorecloud.io/  to start creating the Forms There are 2 important tabs in creating Sitecore Forms  Forms  Webhook(for triggering the submit action) We can create, modify, delete, and activate the form from the Form tab.  Once the form is
Read more

Sitecore Custom Rule (Action and Condition)

-
Image
I have a situation to create a custom Sitecore rule and action for it. v   Goto /Sitecore/system/Settings/Rules/Definitions/Elements v   Create a new item base on the template “ ElementFolder ” with a name “ Custom Rule ” v   Click on the item and create condition and Actions that are necessary for your requirements Condition Template Item: It has two important sections v   Data ·          Text (This is the condition Text which will use tokens to evaluate the condition and user input which will be in [ ] brackets.The brackets contain four positional parameters separated by commas (“,”). 1. The name of the property that the parameter sets in the .NET class that implements the condition. 2. The name of an item beneath the /Sitecore/System/Settings/Rules/Common/Macros item providing predefined functionality, or an empty string. For example, to activate a user interface allowing the user to select an item from the content tree, specify the value tree. 3. URL param
Read more