Sitecore Hackathon 2019 Experience

Its been two weeks since the Sitecore Hackathon, the competition that I wait for to come every year. I would like to write a bit about my experience participating in it.

This is the third year I participate in it with my favorite team (Vision Team) Hanin Daoud and Duaa Abu Gharbieh from Jordan. This time, I participated with them from the USA, and despite the time difference, we were able to make this happen!

Prior to the beginning of the hackathon, my friends and I had a long call discussing some potential ideas that we might be able to use if any of the categories that were going to be presented suit with one of them.

During my work with Sitecore CMS, one of the ideas that I have always wanted to implement is adding a feature to enable the user to select more than one item at a time and delete them all together.

When we received the kick off email, I was so excited that one of the categories presented is suitable with this multi selection idea.

With the great help of my team, we were able to create a multi selection feature that enables the user to select more than one item at the same time, and we implemented this functionality in both publishing and deleting.

Following is a short video explaining what we did:

https://www.youtube.com/watch?v=C0EEo8V9PUI

Unlike the last two hackathons that I participated in, this is the first time that I actually am hopeful to win 😊 as I feel that what we did is a great feature that makes content authors’ lives much easier!

Looking forward to the results of the Hackathon..

Good luck to all participants!

Adding an SMS Link (href=sms:) to the General Link Field Type in Sitecore

In this blog, I am going to explain how to add a custom SMS Link to the General Link Field Type in Sitecore. I always use this sms functionality in my website, so I thought, why not adding it as a custom type in Sitecore so that I would be able make use of it in rendering it as Sitecore Link Field

	@Html.Sitecore().Field(Templates.TemplateName.Fields.ItemLink, Item)
	//The result of the above line would be:
	<a href="sms:[phonenumber];?&body=[body]">Send Text Message</a>

view raw HTMLLinkField hosted with ❤ by GitHub

In order to add this custom sms link, let me walk you through the steps:

1- Login into Sitecore and go to the Core Database.
2- Add a new item under the following path /sitecore/system/Field types/Link Types/General Link/Menu
In the following screenshot, it is named as "SMS".

3- Fill in a display name for this item (e.g Insert SMS Link). This field value is the text that is displayed when you add a general link field to a template and go to an item of this template to inset a link:

4- Set the message field to: contentlink:smslink(id=$Target). This is the case that would navigate the user to the InsertSMSLink Form when he clicks on "Insert SMS Link".

5- Create a class called "SMSLink". This class is going to open the SMS Link Form popup when you click on "Insert SMS Link" link. It checks for the "Message" value and opens the popup accordingly:

	using System;
	using Sitecore;
	using Sitecore.Diagnostics;
	using Sitecore.Shell.Applications.ContentEditor;
	using Sitecore.Text;
	namespace SiteName.Foundation.SitecoreExtensions.Extensions
	{
	public class SMSLink : Link
	{
	// Handles the message field in the SMS Link Field.
	public override void HandleMessage(Sitecore.Web.UI.Sheer.Message message)
	{
	Assert.ArgumentNotNull(message, "message");
	//base handles other message requests
	base.HandleMessage(message);
	string name = message.Name;
	if (name != null)
	{
	switch (name)
	{
	case "contentlink:smslink":
	{
	var url = new UrlString(UIUtil.GetUri("control:SMSLinkForm"));
	//find control and open url
	base.Insert(url.ToString());
	return;
	}
	default:
	{
	return;
	}
	}
	}
	}
	}
	}

view raw SMSLink Class hosted with ❤ by GitHub

6- Navigate back to the Core database, and go to the following path: /sitecore/system/Field types/Link Types/General Link. Set the value of the "Control" field to : content:SMSLink.

7- Add a new customized config file in order to register the SMSLink Control:

	<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
	<sitecore>
	<controlSources>
	<source mode="on" namespace="Sitename.Foundation.SitecoreExtensions.Extensions" assembly="Sitename.Foundation.SitecoreExtensions" prefix="content"></source>
	</controlSources>
	</sitecore>
	</configuration>

view raw SMSLinkRegistrationConfigFile hosted with ❤ by GitHub

8- Now let us add the xml of how the popup would look like when the user clicks on "Insert SMS Link". This file has to be added to the following path : "/sitecore/shell/Applications/Dialogs". Create a new folder there to place the xml file in.

	<?xml version="1.0" encoding="utf-8" ?>
	<control xmlns:def="Definition" xmlns="http://schemas.sitecore.net/Visual-Studio-Intellisense">
	<SMSLinkForm>
	<FormDialog Icon="Network/32x32/mail.png" Header="Insert a Message link"
	Text="Please specify the message and any additional properties. When done, click OK."
	OKButton="OK">
	<CodeBeside Type="Sitename.Foundation.SitecoreExtensions.Extensions.SMSLinkForm,Sitename.Foundation.SitecoreExtensions"/>
	<a id="telephone"></a>
	<GridPanel Class="scFormTable" CellPadding="2" Columns="2" Width="100%">
	<Label For="Text" GridPanel.NoWrap="true">
	<Literal Text="Link description:"/>
	</Label>
	<Edit ID="Text" Width="100%" GridPanel.Width="100%"/>
	<Label For="Url" GridPanel.NoWrap="true">
	<Literal Text="Message:"/>
	</Label>
	<Edit ID="Url" Width="100%" />
	<Label For="Class" GridPanel.NoWrap="true">
	<Literal Text="Style class:" />
	</Label>
	<Edit ID="Class" Width="100%" />
	<Label for="Title" GridPanel.NoWrap="true">
	<Literal Text="Alternate text:"/>
	</Label>
	<Edit ID="Title" Width="100%" />
	</GridPanel>
	</FormDialog>
	</SMSLinkForm>
	</control>

view raw SMSLinkXMLFile hosted with ❤ by GitHub

9- When the user fills in the message, and clicks on Ok, the following code will be executed: Another class is created too as a processor to render the SMS link (RenderSMSLink):

	using System;
	using System.Collections.Specialized;
	using System.Text.RegularExpressions;
	using Sitecore;
	using Sitecore.Diagnostics;
	using Sitecore.Shell.Applications.Dialogs;
	using Sitecore.Web.UI.HtmlControls;
	using Sitecore.Web.UI.Pages;
	using Sitecore.Web.UI.Sheer;
	using Sitecore.Xml;
	namespace Sitename.Foundation.SitecoreExtensions.Extensions
	{
	public class SMSLinkForm : LinkForm
	{
	protected Edit Class;
	protected Edit Text;
	protected Edit Title;
	protected Edit Url;
	public SMSLinkForm()
	{
	}
	private string GetMessage()
	{
	string value = this.Url.Value;
	string str = value;
	if (str.Length > 0)
	{
	if (str.IndexOf(":", StringComparison.InvariantCulture) >= 0)
	{
	str = str.Substring(str.IndexOf(":", StringComparison.InvariantCulture) + 1);
	}
	}
	if (value.Length > 0 && value.IndexOf(":", StringComparison.InvariantCulture) < 0)
	{
	value = string.Concat("sms:", value);
	}
	return value;
	}
	protected override void OnLoad(EventArgs e)
	{
	Assert.ArgumentNotNull(e, "e");
	base.OnLoad(e);
	if (Context.ClientPage.IsEvent)
	{
	return;
	}
	string item = base.LinkAttributes["url"];
	if (base.LinkType != "sms")
	{
	item = string.Empty;
	}
	this.Text.Value = base.LinkAttributes["text"];
	this.Url.Value = item.Replace("sms:", "");
	this.Class.Value = base.LinkAttributes["class"];
	this.Title.Value = base.LinkAttributes["title"];
	}
	protected override void OnOK(object sender, EventArgs args)
	{
	Assert.ArgumentNotNull(sender, "sender");
	Assert.ArgumentNotNull(args, "args");
	string sms = this.GetMessage();
	Packet packet = new Packet("link", new string[0]);
	LinkForm.SetAttribute(packet, "text", this.Text);
	LinkForm.SetAttribute(packet, "linktype", "sms");
	LinkForm.SetAttribute(packet, "url", sms);
	LinkForm.SetAttribute(packet, "anchor", string.Empty);
	LinkForm.SetAttribute(packet, "title", this.Title);
	LinkForm.SetAttribute(packet, "class", this.Class);
	SheerResponse.SetDialogValue(packet.OuterXml);
	base.OnOK(sender, args);
	}
	}
	public class RenderSMSLink
	{
	public void Process(Sitecore.Pipelines.RenderField.RenderFieldArgs args)
	{
	if (args != null && (args.FieldTypeKey == "link" || args.FieldTypeKey == "general link"))
	{
	Sitecore.Data.Fields.LinkField linkField = args.Item.Fields[args.FieldName];
	if (!string.IsNullOrEmpty(linkField.Url) && linkField.LinkType == "sms")
	{
	args.Parameters["href"] = linkField.Url;
	}
	}
	}
	}
	}

view raw SMSLinkInsertMessageHandle hosted with ❤ by GitHub

10- In order for this processor to work, you need to patch a configuration for it under the pipelines section:

	<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
	<sitecore>
	<pipelines> <renderField>
	<processor patch:before="*[@type='Sitecore.Pipelines.RenderField.GetLinkFieldValue, Sitecore.Kernel']" type="Sitename.Foundation.SitecoreExtensions.Extensions.RenderSMSLink, Sitename.Foundation.SitecoreExtensions" />
	</renderField>
	</pipelines>
	</sitecore>
	</configuration>

view raw RenderSMSLinkPipeline hosted with ❤ by GitHub

You are all set now!

This way, we are going to still be able to render the link as an Html Sitecore Link (@Html.Sitecore().Field(Templates.TemplateName.Fields.ItemLink,Item))

Hope this is useful :)

Happy Coding!

Sitecore Symposium 2017 - Day Three And Four Experience

This day started with a lovely breakfast, mingling with Sitecore people then the keynote for the day.

Jake Johannsen was a guest at the symposium and he was the one starting and ending our days talks with a beautiful flavor and his funny jokes :D

Some of the sessions I attended was about people sharing there experience in dealing with Sitecore, like implementing Sitecore solutions with Helix and deploying Sitecore Microsoft Azure. Some Sessions were actually demos to the steps followed to implement this.

One of the main topics I was interested in was implementing personalization in Sitecore, discuss the nuts and bolts of using this tool, and see how do I get started with it.

Day 3 ended with an amazing chat between the Legendary actor, producer and writer Mark Hamill and Scott Anderson (Sitecore CMO). He was talking about his experiences playing iconic "Star Wars" character.

Day 4 was the last day for the symposium which started with a breakfast as usual :) and some sessions like the Sitecore rules engine, getting started to cloud.

Last keynote of the day was giving us a glimpse of the of the future product direction of Sitecore and when is the venue of the Symposium 2018 going to be.. which is Orlando!

It was a lovely experience after all and I am really looking forward to next year's one!

Sitecore Symposium 2017 - Day Two Experience

So day 2 started at 7 am with enthusiasm. I was looking forward to the amazing experience I am going to get. This was the first day of sessions too!

It started with an introduction to what is new in Sitecore world regarding the newest versions, enhanced functionalities and new features in Sitecore like Sitecore xConnect, Cortex, etc..

The sessions that I was in interested in and I did attend them had to do with implementing xDB and EXM, deep dive into SXA, and implementing Sitecore on Microsoft Azure.

It was a long lovely day getting to know the Sitecore community and expanding my Sitecore knowledge.  Second day finished at 5 o'clock.

Stay tuned for my Day 3 experience :)

Sitecore Symposium 2017 - Day One Experience

Attending Sitecore symposium was one of my main goals to achieve, despite the long trip I went through to reach Vegas!

So yesterday was the first day of the Symposium, my feeling was like how am I gonna introduce myself to people :) the registration went smoothly.

At the reception, I got to see and meet people in person and it was an honor to meet this love community. The reception was amazing. I even won the NishTech 100 Dollars Amazon prize :)

It was good to get to know Sitecore partners in the Partners Pavilion and visit the booths to know more about Sitecore business.

Looking forward to the second day of the symposium and starting the sessions.

Sitecore Publishing Service on CM – CD Environments

Publishing Service is one of the great features Sitecore has. I used to have issues publishing my site as there are lots of items in there and it was a slow procedure since that you need to wait until the publishing ends so that you would be able to continue working on Sitecore. 

Now, with this service, you are able to continue working on Sitecore while publishing your site, plus this process is much faster than before.

The reason behind me writing this blog is to focus on the publishing service installation on a content management server as I faced a couple of issues before installing it on sitecore, so I would like to share those issues with you.

 As we know, one of the basic steps that needs to be done before installing the service is to install the .NET Core. When I followed the steps to install the service host, I used to get an error when trying to test if the service works before installing it on Sitecore (you should get the following result {"status":0} usually to make sure that the service works fine but I never got it).

The error was not informative to be able to figure out the issue. After some investigation and the help of Sitecore Support, I found out that installing .NET Core is not enough on the CM server. You need to make sure that the ASPNetCoreModule is installed (This is required to host .NET Core projects in IIS). You can check if it is installed by opening IIS and looking for it in the modules section.

If you didn’t find it, you need to install ASP.NET Core Server Hosting Bundle (http://go.microsoft.com/fwlink/?LinkId=798480), and this would solve the issue.

When installing the service host and adding the connection strings file that connects the service with the Sitecore databases, you need to add another node for the pub database. Moreover, you need to add a target definition node under the “targets” node for the pub database:

	<Targets>
	<DEV-CM>
	<Type>Sitecore.Framework.Publishing.Data.DatabaseConnection, Sitecore.Framework.Publishing.Data</Type>
	<As>Sitecore.Framework.Publishing.Data.IDatabaseConnection, Sitecore.Framework.Publishing.Abstractions</As>
	<Lifetime>Transient</Lifetime>
	<Options>
	<CommandTimeout>360</CommandTimeout>
	<ConnectionName>web</ConnectionName>
	<ConnectionString>${Sitecore:Publishing:ConnectionStrings:Web}</ConnectionString>
	<DbConnectionType>SqlConnection.Default</DbConnectionType>
	<!-- The id of the target item definition in Sitecore -->
	<Id>8E080626-DDC3-4EF4-A1D1-F0BE4A200254</Id>
	</Options>
	</DEV-CM>
	<LIVE-CD>
	<Type>Sitecore.Framework.Publishing.Data.DatabaseConnection, Sitecore.Framework.Publishing.Data</Type>
	<As>Sitecore.Framework.Publishing.Data.IDatabaseConnection, Sitecore.Framework.Publishing.Abstractions</As>
	<Lifetime>Transient</Lifetime>
	<Options>
	<CommandTimeout>360</CommandTimeout>
	<ConnectionName>pub</ConnectionName>
	<ConnectionString>${Sitecore:Publishing:ConnectionStrings:Pub}</ConnectionString>
	<DbConnectionType>SqlConnection.Default</DbConnectionType>
	<!-- The id of the target item definition in Sitecore -->
	<Id>8B917481-E144-467F-888A-6313431D67EE</Id>
	</Options>
	</LIVE-CD>
	</Targets>

view raw Targets Node - Sitecore Publishing Service hosted with ❤ by GitHub

Note: The target node should have the same name as the publishing target item name in Sitecore. Ex.: “DEV-CM”.

Hope this blog is useful :)

Custom Experience Analytics Reports

Sitecore has really cool features to implement. One of them is creating custom reports in the Experience Analytics Dashboard. Sometimes, customers need to know essential information in order to improve their website.

In order to improve the website content and words used in its pages (SEO), the customer needs to know what are the most used words in the site search. Therefore, I am going to walk you through the steps to track the words used in the site search and creating a report that displays those words and how many times are they being searched for.

By default, the internal search keywords are not being tracked in Sitecore. Therefore, in order to track them, appropriate search event should be registered when the search occurs.

Following code should be added when the user searches for a word in the site, and hits submit:

	var interaction = Tracker.Current.Session.Interaction;
	// init with name and item id of search page event
	var pageEventData = new Sitecore.Analytics.Data.PageEventData("Search", Guid.Parse("{0C179613-2073-41AB-992E-027D03D523BF}"))
	{
	//Item ID of the search page
	ItemId = Sitecore.Context.Item.ID.ToGuid(),
	Data = "Keywords",
	//keyword that will be reported in the report:
	Text = "search keyword",
	DataKey = " search keyword",
	};
	interaction.CurrentPage.Register(pageEventData);

view raw Local Search Keyword Tracking hosted with ❤ by GitHub

The above code means that the search keyword is being tracked and saved in Interactions table in the analytics mongoDB:

The data then gets aggregated to the “Fact_SiteSearches” table in the Analytics database in SQL.

We’re almost there! All what we have to do now is to create a custom report in the Experience Analytics Dashboard to show the words and their count.

To create a report page, you should do the following:

1. You should have Sitecore rocks installed and a connection created to your website.
2. Navigate to the core database in the website content tree using the following path: core/sitecore/client/Applications/ExperienceAnalytics/Dashboard
3. Right click on any report category (for example Aquisition), and click on Add – New Item.
4. Select the “ExperienceAnalyticsReportPage” template, and enter a term (recommended to start with “experienceanalytics”).
5. Click Ok.
6. There will be PageSettings created by default under the report item you just created.

Now, we have to choose a chart component to the report created. In order to do so, follow the below steps:

1. In Sitecore Rocks, right click on the report page item you created, and click on Tasks – Design Layout.
2. In the Design Layout, click on Add Rendering.
3. In the dialog box, select a chart control to use for your report (Example: select an “ExperienceAnalyticsBarChart” if you want to display a bar chart).
4. Click Ok after choosing the rendering you want.

After that, you need to add a parameters item to configure the report metrics (which will be “Count” in our example):

1. Right click on the PageSettings item that is under the report item that you created and click Add- New Item.
2. We will have to choose the “ExperienceAnalyticsBarChart Parameters” since that we chose the “ExperienceAnalyticsBarChart” rendering.
3. Enter a proper name for it and hit Ok.
4. Double click on the new parameter that you added in order to configure the metrics there.
5. Choose the “Count” option from the “metrics” field and hit save.

Last step we should do is to bind the bar chart we created with the parameters item that we added. This is done by doing the following:

1. Right click on the report item and choose Task - Design Layout.
2. Double click the chart item “ExperienceAnalyticsBarChart control”. In the Edit Rendering Properties box – Behaviour – Datasource, browse the location of the parameter you created.
3. Click Ok.

We are done now! You can go the Experience Analytics dashboard to check the report you created:

Note: The data is being displayed from the view that is in the Analytics database (dbo.SiteSearches)

Happy Sitecore Coding!