Category Archives: Sitecore

This category would contains all post related to Sitecore Experience Profile

Maintaining code quality with SonarQube

November 1, 2017Tips & Best Practicesbest practices, sonarqubeRey Rahadian

When working in a large solution of a project that’s been going on for years (Sitecore project or not), there’s bound to be technical debts here and there. Technical decisions which were taken in not an ideal condition which leads to shortcuts being made, not necessarily wrong decisions but the best decisions considering the situation at the time.

So how does one maintain and improve code quality with such code base? especially when people would come and go on the project and without fully understanding the code base as a whole they would perform the bare minimum to complete the work which usually ends up as more technical debts which never gets pick-up as it gets buried deep within the code base as time goes.

There are several ways we can help reduce the on-going technical debts by:

Increasing our test coverage (unit test, functional test, integration test)
Doing PR review
Implementing the boy scout rule for every PR (leave the camp ground cleaner when you first arrived)

Been digging around for the last week seeking for ways to extract the health state of a code base and get some sort of stats for which we can then define as a baseline for improvement iterations. Which then I had a quick look at what tools available and gathered my notes on SonarQube.

I first heard about SonarQube in my old company 4 years back (was called Sonar back then). I never gave much thought of it back then but now decided to have a quick look into it and so far I like what I’m seeing and the capabilities it have.

One of the main reasons why I’m so keen with this tool is that it can provides the stats that I’m looking for from the current code base, the key thing to know if you’re doing some sort of improvements you would need to have concrete parameters. Another big reason is since the tools has been around for a while and matured, it has lots of plugins – including plugins which integrate nicely to our tooling and processes.

Here’s some of my notes so far on this tool which looks pretty cool.

Integration with the developer experience

Integrate with Visual Studio
- https://www.sonarlint.org/visualstudio/
Integrate with Resharper
- https://docs.sonarqube.org/display/PLUG/ReSharper+Plugin

Integration with JIRA

https://docs.sonarqube.org/display/PLUG/JIRA+Plugin

This plugin can create JIRA tickets based on SonarQube reports. At the time of writing this plugin has been labeled as deprecated though.

Integration with Team City

https://confluence.jetbrains.com/display/TW/SonarQube+Integration

This plugin offers the following features:

Easy SonarQube Runner deployment and configuration

SonarQube Server connections management

Test results locator. Works for Surefire and MSTest reports at the moment

JaCoCo coverage result locator

Navigation to SonarQube Server from the TeamCity UI: the View in sonar link on the Build Results page takes you to the sonar dashboard of the analysed project once the build is finished.

SonarQube`s Build Breaker plugin support

Now, you don’t really need this plugin if all you need is to run the SonarQube analysis runner and view the report in the SonarQube web application. All you need is just to execute the SonarQube analysis runner command which will generate the XML report files when you build your solution file and send it to the SonarQube server.

Integration with Bitbucket

https://marketplace.atlassian.com/plugins/ch.mibex.bitbucket.sonar/cloud/overview

Extract the health state of your code base

Highlight failed quality checks

Instant feedback in your PR – really cool I’d say 🙂

So far it looks really promising, hopefully I can share more on this tool as I get some time to play around with it.

How TDS Git Delta Deploy make my life easier

October 20, 2017Sitecore, TDS, Tips & Best PracticesSitecore TDS, sitecore-tipsRey Rahadian

In one of recent project that I’ve encountered most of the team members raise the concern about having a such long production deployment time, which could span the entire normal working hours and even more if they encountered some issues.

One of the thing that I noticed can be optimized immediately is the TDS package installation process, where instead of installing the full TDS packages which can contains thousands of items (in my case it was more than 12,000 items) we can instead use the option of only deploying the delta items – which for every release cycle (2 weeks) normally amount to around 50 items or even less.

The TDS Git Delta Deploy itself is something that Sitecore MVP Sean Holmesby created to answer how to have a true “delta” of content items to be deployed to the target environment. Have a read of the full article here.

So, I know the solution of one the paint point area then I just need to install Sean’s nuget package and go on my merry way right? well.. not exactly.

The problem

In the current solution the team have multiple TDS projects per features (Helix anyone?), those TDS projects would then be bundled using TDS package bundling to create the final combined package.

To give a little bit of illustration, see below:

Given the following TDS projects

TDS Foundation Z
TDS Feature A
TDS Feature B
TDS Feature C
TDS Project X (will bundle all content items from the above TDS projects)

So what’s the problem? the package bundling doesn’t respect the TDS Git Delta Deploy it will always include all the items instead of just the delta.

The solution

I reached out to the nice folks in the #tds slack channel in https://sitecorechat.slack.com/ for suggestions – btw if you haven’t joined then I suggest you do that first else you’re missing out 🙂

Not long after I raised the question, John Rappel replied that he has a fix for that in the latest nuget package – awesome!. I upgraded the nuget package and true enough that it now works. Read more about John’s bugfixes and feature updates here.

So now I got TDS delta packages working locally, it’s now time to integrate it in our Continuous Build process.

The setup in Team City

TDS Git Delta Deploy work by using “git diff” command in it’s core, which for this to work correctly you would need to ensure that:

TC is configured to use the agent side checkout
- https://confluence.jetbrains.com/display/TCD10/VCS+Checkout+Mode
TC is doing a full “git fetch” instead of just retrieving a single branch
- If you’re using TC version 10.0.4 and above you’re in luck as apparently you can set it using the following approach
- If you’re using TC version prior 10.0.4 then your other option to have this is to do a custom build step that perform a git fetch

A quick POC confirm that the approach is solid and I see those delta packages being generated!

TDS Delta packages generated.. what now?

With the TDS delta packages generated and ready to use, all we have to do now is to include it as part of our Continuous Deployment process. We’re using Octopus Deploy so it’s quite easy to setup.

You can use something like Sitecore Package Deployer to automate the package installation process and include it as part of Octopus deploy step. In our case, since we already have an existing custom web service that does the same job so we leverage that instead.

quick tip:

Enable TDS “publish package after deploy” to streamline the deployment process by automatically publishing only the deployed items

here’s the reference on how to do just that https://hedgehogdevelopment.github.io/tds/chapter4.html

What’s the outcome?

Having all this in place really helped streamlined the way we do a Sitecore deployment and cut massive time which in turns faster deployment => more time to work on something else => productivity++

Sitecore logging integration with Graylog

July 28, 2017Sitecore, Tips & Best PracticesRey Rahadian

With Sitecore infrastructure which expands beyond the basic 1 CM and 1 CD, having a centralized logging mechanism is crucial in order to understand what happens in the servers in a consolidated view.

Some of the popular APM out there in the market offers an automatic records of exception/errors which occurred in the application, this proves really useful when investigating a problem down to the exact line of code which raised the exception. Some types of issues requires you to dig through the Sitecore logs in order to gain an understanding what happened in the server itself , for example when investigating publishing issues, security audits, index crawling, exm logs and fxm logs in the delivery servers.

For those types issues we typically look at different types of Sitecore logs in each servers in order to find out what exactly happened, if we have multiple servers in the picture we would need to go into each servers or pull down the log files from each servers and analyze the log files. This is where centralized logging for Sitecore logs will come in handy as we would have a centralized view of the log files which span multiple servers and we can perform a search query against the log information.

A couple of centralized Log provider in the market are:

https://azure.microsoft.com/en-us/services/application-insights/
https://www.splunk.com/
https://www.elastic.co/products/elasticsearch
https://www.graylog.org/

I stumble across Graylog in a recent project where we currently pushing windows event logs to it but not the Sitecore log information yet. So I played around with it a bit to get a feel *rolling sleeves*.

There’s a couple of steps that we need to figure out in order to integrate the Sitecore logs to Graylog

Create a custom log appender
Install Graylog server
Configure Graylog server
Send Sitecore log information to Graylog server

Create a custom log appender

Sitecore uses log4net as the logging framework which is extensible, by default it uses the LogFileAppender class which outputs the log information in text files.

As I want to send the Sitecore log information to Graylog server through http protocol, I would need to create a custom log appender. And as sending log information from Sitecore to Graylog server needs to be in a certain format, GELF format to be precise, we would need to format the log format to match GELF specification in order for Graylog server to understand and able to parse it.

I found the gelf4net library which was mentioned in the Graylog documentation which already did all the heavy lifting of formatting the data. When I installed the nuget package and configured the log4net section in Sitecore according to this library documentation it doesn’t work though.

One gotcha that I found is that when we want to create a custom log appender in Sitecore , we need to reference the AppenderSkeleton class in the Sitecore.Logging assembly – previously I added log4net nuget package (comes with gelf4net as a dependency) and was hoping that would work, instead it failed miserably 🙁

In the end I created my own appender class which replicate gelf4net appender implementation. https://github.com/reyrahadian/sitecore-gelf-logappender/blob/master/ScGraylog/Appender/GelfHttpAppender.cs

Install Graylog server

Having read through the Graylog documentation, the easiest and quickest way to setup a Graylog server for my POC is to download the VM. It’s all preconfigured, we just need to load the .voa file using VMware player or VirtualBox to get it up and running.

reference: http://docs.graylog.org/en/latest/pages/getting_started.html

Configure Graylog server

The next things that we need to do after we have our Graylog server up and running is to configure the input source. There’s multiple options that Graylog provides: http, tcp, udp or file dumps.

HTTP input source fits what I need for my POC, so I created a new HTTP input source and have it running.

Send Sitecore log information to Graylog server

Here’s where we put things together. With our custom log appender ready, now we only need to send the Sitecore log information to our Graylog server by using the following log4net configuration

<?xml version="1.0"?>
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
	<sitecore>
		<log4net>
			<appender name="GelfHttpAppender" type="ScGraylog.Appender.GelfHttpAppender, ScGraylog">
				<url value="http://10.0.0.126:12201/gelf" />
				<layout type="ScGraylog.Layout.GelfLayout, ScGraylog">
					<conversionPattern value="%4t %d{ABSOLUTE} %-5p %m%n" />
				</layout>
			</appender>
			<root>
				<appender-ref ref="GelfHttpAppender" />
			</root>
		</log4net>
	</sitecore>
</configuration>

<?xml version="1.0"?>

</layout>

</appender>

<root>

<appender-ref ref="GelfHttpAppender" />

</root>

</log4net>

</sitecore>

</configuration>

Check if things works as expected

If everything works as expected then you should see some log information coming from Sitecore

source code: https://github.com/reyrahadian/sitecore-gelf-logappender

Sitecore Commerce Server Connect.10.0.70.update package installation hangs

July 10, 2017Issues & Resolution, Sitecore, Sitecore Commercesitecore-commerce, troubleshootingRey Rahadian

I had a strange issue where I previously able to successfully setup a couple of Sitecore Commerce 8.2.1 initial release instances then suddenly creating a new instance keeps failing.

To be exact, it was failing when trying to install Sitecore Commerce Server Connect.10.0.70.update package through the Sitecore update installation wizard page, it just keeps loading indefinitely. Changing the Sitecore log files to DEBUG mode and checking the Windows event log file doesn’t reveal anything. I do notice that memory consumption for the W3WP process is absurdly high in my local machine and it seems like something went wrong.

True enough, after debugging the W3WP process it reveals that the process throws a StackOverflow exception which stems from NewRelic Agent process that I’ve installed yesterday. Uninstalling the NewRelic Agent seems to fix this issue and I’m able to continue with the packages installation per normal.

Extend Sitecore Engagement Plan UI to assign contacts to an engagement plan state

March 14, 2017Analytics, Sitecoresitecore, sitecore how-toRey Rahadian

The default Sitecore Engagement Plan currently supports the following option to assign users/contacts to an engagement plan state

Add from CSV File
Add a Sitecore user
Add all Members of a Sitecore Role
Add a Segment

Out off all those options only the segment option have the capability of assigning existing contacts to an engagement plan state.

However, what if we would like to import contacts from a CSV file there’s no option to do so, the Add from CSV file will import the data as Sitecore users instead of contacts.

We would need to modify the UI in order to achieve the functionality that we’re aiming for. To do so first we would need to figure which file to modify.

As the UI is using Silverlight it’s a bit difficult to figure which file we need to modify, however searching for the “Welcome to the Import Contacts Wizard” text under the /sitecore folder reveals that this file seems to be the correct one

\sitecore\shell\Applications\MarketingAutomation\Dialogs\ImportVisitors.xml

1	\sitecore\shell\Applications\MarketingAutomation\Dialogs\ImportVisitors.xml

Further inspecting the code inside that file and tinkering with it a bit confirms that this is the correct file to modify.

We will not modify the existing Sitecore file, instead we will use the Override folder in order to apply our modification to the existing XML control. To do this copy and paste the existing ImportVisitors.xml file to the override folder

\sitecore\shell\Override\Applications\MarketingAutomation\Dialogs\ImportVisitors.xml

1	\sitecore\shell\Override\Applications\MarketingAutomation\Dialogs\ImportVisitors.xml

You can put the file directly inside the Override folder, but it’s good practice to replicate the original folder paths so you know which file you’re overriding. After we now know which file to modify we can start modifying the default behaviour of that XML control.

The modified ImportVisitors.xml

<?xml version="1.0" encoding="utf-8" ?>
<control xmlns:def="Definition" xmlns="http://schemas.sitecore.net/Visual-Studio-Intellisense">
  <ImportVisitors>
    <WizardForm CodeBeside="TC.SitecoreEngagementPlanUI.Shell.Applications.MarketingAutomations.Dialogs,TC.SitecoreEngagementPlanUI">

      <style type="text/css">
        th.scListviewViewDetailsHeader
        {
        display:none;
        }

        #RolesBox div
        {
        padding-bottom: 2px;
        }

        input
        {
        font-family: verdana;
        font-size: 9pt;
        }

        .orderedList{
        list-style-type: decimal;
        list-style-position: inside;
        }

        .orderedList > li{
        list-style-position: inside;
        padding-left: 8px;
        list-style-type: square;
        }
      </style>

      <WizardFormFirstPage ID="FirstPage" Icon="People/32x32/users_into.png">
        <Border Class="scWizardWelcomeTitle">
          <Literal Text="Welcome to the Import Users/Contacts Wizard" />
        </Border>
        <Literal Text="This wizard helps you:" />
        <ul>
          <li class="scWizardBullet">
            <Literal Text="Select a CSV file that contains visitor information." />
          </li>
          <li class="scWizardBullet">
            <Literal Text="Then do one of the followings:" />
            <ol>
              <li class="scWizardBullet">
                <Literal Text="1. Import as a user" />
                <ul class="orderedList">
                  <li class="scWizardBullet">
                    <Literal Text="Map the information in the file to the fields in the user profile." />
                  </li>
                  <li class="scWizardBullet">
                    <Literal Text="Select a domain for new visitors." />
                  </li>
                  <li class="scWizardBullet">
                    <Literal Text="Add visitors to the selected domain." />
                  </li>
                  <li class="scWizardBullet">
                    <Literal Text="Add visitors to a state." />
                  </li>
                </ul>
              </li>
              <li class="scWizardBullet">
                <Literal Text="2. Import as a contact" />
                <ul class="orderedList">
                  <li class="scWizardBullet">
                    <Literal Text="Map the information in the file to contact fields" />
                  </li>
                  <li class="scWizardBullet">
                    <Literal Text="Add visitors to a state." />
                  </li>
                </ul>
              </li>
            </ol>
          </li>
        </ul>
      </WizardFormFirstPage>

      <WizardFormPage ID="ChooseAction" Header="Choose action" Text="Choose to import as a user or contact">
        <WizardFormPadding>
          <GridPanel Width="100%" Valign="top">
            <Label Header="Import Action:" GridPanel.VAlign="top" />
            <Space Height="16" />
            <Radiobutton ID="ImportUsers" Name="ChooseAction" Value="ImportUsers" Header="Import as Users"></Radiobutton>
            <Literal Text="Importing as Users will import the visitor as a registered User in Sitecore" Style="font-weight:bold;" GridPanel.Colspan="2"/>
            <Space Height="8" />
            <Radiobutton ID="ImportContacts" Name="ChooseAction" Value="ImportContacts" Header="Import as Contacts"></Radiobutton>
            <Literal Text="Importing as Contacts will import the visitor as a Contact in the Sitecore xDB" Style="font-weight:bold;" GridPanel.Colspan="2"/>
          </GridPanel>
        </WizardFormPadding>
      </WizardFormPage>

      <WizardFormPage ID="SelectFile" Header="File to Import" Text="Select the CSV file that contains the visitor information that you want to import. This file must be in .csv format." Icon="People/32x32/users_into.png">
        <WizardFormPadding>
          <GridPanel Width="100%" VAlign="top" Cellspacing="4" >

            <Label Header="File Name:" GridPanel.VAlign="top" />

            <GridPanel GridPanel.VAlign="top" Columns="3" Width="100%">
              <Edit ID="Filename" GridPanel.Width="100%" Width="100%" ReadOnly="true" />
              <Space Width="6px" />

              <Border Width="75px" GridPanel.Width="75px">
                <Border Style="position: relative;">
                  <Frame ID="UploadFileFrame" Height="26px" Style="position: relative; -moz-opacity:0; filter:alpha(opacity: 0);	opacity: 0;	z-index: 2;" SourceUri="/sitecore/shell/Applications/MarketingAutomation/Dialogs/UploadFile.aspx"/>
                  <button class="scButton" type="button" Style="position: absolute; top: 1px; left: 0px; z-index: 1;">
                    <Literal Text="Browse" />
                  </button>
                </Border>
              </Border>
            </GridPanel>

          </GridPanel>
        </WizardFormPadding>
      </WizardFormPage>

      <WizardFormPage ID="Fields" Header="Fields" Text="Select the fields that you want to import and the fields that you want to map them to." Icon="People/32x32/users_into.png">
        <WizardFormPadding>
          <GridPanel Height="100%" Width="100%">
            <GridPanel Width="100%" VAlign="top" Cellspacing="8" Style="padding-left: 4px;">
              <Label Header="User Name:" />
              <EditableCombobox ID="UserName" SelectOnly="true" Width="100%" />
            </GridPanel>

            <Scrollbox ID="FieldsSection" GridPanel.Height="100%" Border="0" Style="background: transparent;">
              <GridPanel Width="100%" VAlign="top" Cellspacing="8" Columns="3" >

                <Label Header="From:" GridPanel.Width="50%" />
                <Label Header="To:" GridPanel.Width="50%" />
                <Border Height="16" Width="16" />

              </GridPanel>
            </Scrollbox>
          </GridPanel>
        </WizardFormPadding>
      </WizardFormPage>

      <WizardFormPage ID="DomainAndRole" Header="Domain and Role" Text="Select the security domain and role (optional) that you want to add new visitors to." Icon="People/32x32/users_into.png" >
        <WizardFormPadding>
          <GridPanel Width="100%" VAlign="top" >

            <Label Header="Domain:" />
            <Space Height="4"/>
            <EditableCombobox ID="DomainCombobox" SelectOnly="true" Width="100%" Visible="false" />

            <GridPanel ID="DomainPanel" GridPanel.VAlign="top"  Columns="3" Width="100%" Visible="false">
              <Edit ID="DomainInput" GridPanel.Width="100%" Width="100%" ReadOnly="true" />
              <Space Width="6px" />
              <Button Header="Select" Click="SelectDomain_Click" />
            </GridPanel>

            <Space Height="8"/>

            <Label Header="Role (optional):" />
            <Space Height="4"/>
            <GridPanel GridPanel.VAlign="top" Columns="3" Width="100%">
              <Edit ID="RoleInput" GridPanel.Width="100%" Width="100%" />
              <Space Width="6px" />
              <Button Header="Select" Click="SelectRole_Click" />
            </GridPanel>

            <Space Height="34"/>

            <Label Header="If a record in the file contains a user name that already exists:" />
            <Space Height="4"/>

            <GridPanel Cellspacing="0">
              <Radiobutton ID="SkipProperties" Name="Conflict" Value="SkipProperties" Header="Do not modify profile fields." Checked="true" />
              <Radiobutton ID="OverwriteProperties" Name="Conflict" Value="OverwriteProperties" Header="Overwrite existing profile fields." />
              <Radiobutton ID="StoreProperties" Name="Conflict" Value="StoreProperties" Header="Only store data in empty profile fields." />
            </GridPanel>

          </GridPanel>
        </WizardFormPadding>
      </WizardFormPage>

      <WizardFormPage ID="ContactFields" Header="Contact Fields" Text="Select the field that you want to identify the contact as" Icon="People/32x32/users_into.png">
        <WizardFormPadding>
          <GridPanel Width="100%" VAlign="top" Cellspacing="8" Style="padding-left: 4px;">
            <Label Header="Contact Identifier (required):" />
            <EditableCombobox ID="ContactIdentifier" SelectOnly="true" Width="100%" />
            <Space Height="16" />
            <Label Header="First Name:" />
            <EditableCombobox ID="ContactFirstName" SelectOnly="true" Width="100%" />
            <Space Height="16" />
            <Label Header="Last Name:" />
            <EditableCombobox ID="ContactLastName" SelectOnly="true" Width="100%" />
            <Space Height="16" />
            <Label Header="Contact Email:" />
            <EditableCombobox ID="ContactEmail" SelectOnly="true" Width="100%" />
          </GridPanel>
        </WizardFormPadding>
      </WizardFormPage>

      <WizardFormPage ID="Importing" Header="Importing Contacts" Text="Please wait while the wizard imports visitors." Icon="People/32x32/users_into.png">
        <WizardFormPadding>
          <GridPanel Width="100%" VAlign="Top">
            <Space Height="64" />
            <Border Align="center">
              <ThemedImage Src="People/32x32/users_into.png" Width="48" Height="48" />
            </Border>
            <Space Height="16" />
            <Border Align="center">
              <ThemedImage Src="Images/progress.gif" Width="94" Height="17" />
            </Border>
            <Space Height="16" />
            <Border Align="center" >
              <Literal Text="Importing..." Style="font-weight:bold"/>
            </Border>
          </GridPanel>
        </WizardFormPadding>
      </WizardFormPage>

      <WizardFormLastPage ID="Finish" Icon="People/32x32/users_into.png">
        <GridPanel Width="100%">
          <Literal Text="The visitor information has been imported successfully." />

          <Border>
            <Space Height="14px" />
          </Border>

          <Border ID="Results">
            <GridPanel Columns="2" Cellspacing="6" Valign="top">
              <Literal Text="Importing" Style="font-weight:bold;" GridPanel.Colspan="2"/>
              <Literal ID="LiteralUsersImported" Text="Users imported:" Style="padding-left: 14px;"/>
              <Literal ID="NumImported" />

              <Border GridPanel.Colspan="2">
                <Space Height="16px" />
              </Border>

              <Literal ID="SkippedText" Text="Records skipped:" GridPanel.Colspan="2" Style="padding-left: 14px;" />

              <Literal ID="LiteralUserExists" Text="User exists:" Style="padding-left: 28px;"/>
              <Literal ID="NumUserExists" />

              <Literal ID="LiteralBadUserName" Text="Invalid user name:" Style="padding-left: 28px;"/>
              <Literal ID="NumBadUserName" />

              <Literal ID="LiteralBrokenStructure" Text="Broken stucture:" Style="padding-left: 28px;"/>
              <Literal ID="NumBroken" />

              <Border GridPanel.Colspan="2">
                <Space Height="16px" />
              </Border>

              <Literal Text="Adding to state" Style="font-weight:bold" GridPanel.Colspan="2"/>

              <Literal Text="Contacts added to state:" Style="padding-left: 14px;"/>
              <Literal ID="NumAddedToState" />
            </GridPanel>
          </Border>
        </GridPanel>
      </WizardFormLastPage>

    </WizardForm>
  </ImportVisitors>
</control>

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

<?xml version="1.0" encoding="utf-8" ?>

th.scListviewViewDetailsHeader

{

display:none;

}

#RolesBox div

{

padding-bottom: 2px;

}

input

{

font-family: verdana;

font-size: 9pt;

}

.orderedList{

list-style-type: decimal;

list-style-position: inside;

}

.orderedList > li{

list-style-position: inside;

padding-left: 8px;

list-style-type: square;

}

</style>

</Border>

<ul>

</li>

<ol>

</li>

</li>

</li>

</li>

</ul>

</li>

</li>

</li>

</ul>

</li>

</ol>

</li>

</ul>

</WizardFormFirstPage>

</GridPanel>

</WizardFormPadding>

</WizardFormPage>

</button>

</Border>

</GridPanel>

</WizardFormPadding>

</WizardFormPage>

</GridPanel>

</GridPanel>

</Scrollbox>

</GridPanel>

</WizardFormPadding>

</WizardFormPage>

</GridPanel>

</GridPanel>

</GridPanel>

</WizardFormPadding>

</WizardFormPage>

</GridPanel>

</WizardFormPadding>

</WizardFormPage>

</Border>

</Border>

</Border>

</GridPanel>

</WizardFormPadding>

</WizardFormPage>

</Border>

</Border>

</Border>

</GridPanel>

</Border>

</GridPanel>

</WizardFormLastPage>

</WizardForm>

</ImportVisitors>

</control>

The code beside file

using System;
using System.Collections.Generic;
using System.Web;
using Sitecore;
using Sitecore.Analytics;
using Sitecore.Analytics.Automation.MarketingAutomation;
using Sitecore.Analytics.Data;
using Sitecore.Analytics.DataAccess;
using Sitecore.Analytics.Model;
using Sitecore.Analytics.Model.Entities;
using Sitecore.Analytics.Tracking;
using Sitecore.Configuration;
using Sitecore.Data;
using Sitecore.Diagnostics;
using Sitecore.Globalization;
using Sitecore.IO;
using Sitecore.Jobs;
using Sitecore.Resources;
using Sitecore.Web.UI.HtmlControls;
using Sitecore.Web.UI.Sheer;

namespace TC.SitecoreEngagementPlanUI.Shell.Applications.MarketingAutomations.Dialogs
{
    public class ImportVisitorsForm : Sitecore.Shell.Applications.MarketingAutomation.Dialogs.ImportVisitorsForm
    {
        protected EditableCombobox ContactEmail;
        protected EditableCombobox ContactFirstName;
        protected EditableCombobox ContactIdentifier;
        protected EditableCombobox ContactLastName;
        protected Radiobutton ImportContacts;
        protected Radiobutton ImportUsers;
        protected Literal LiteralBadUserName;
        protected Literal LiteralBrokenStructure;
        protected Literal LiteralUserExists;
        protected Literal LiteralUsersImported;

        protected ImportActionType ImportAction
        {
            get
            {
                if (ImportUsers.Checked)
                    return ImportActionType.ImportAsUser;

                if (ImportContacts.Checked)
                    return ImportActionType.ImportAsContact;

                return ImportActionType.Unknown;
            }
        }

        protected override bool ActivePageChanging(string page, ref string newpage)
        {
            Assert.ArgumentNotNull(page, "page");
            Assert.ArgumentNotNull(newpage, "newpage");
            switch (page)
            {
                case "ChooseAction":
                    if (ImportAction == ImportActionType.Unknown)
                    {
                        SheerResponse.Alert("Please select one of the action available");
                        return false;
                    }
                    break;
                case "SelectFile":
                    if (newpage.Equals("Fields") && !ReadFile())
                        return false;
                    if ((ImportAction == ImportActionType.ImportAsContact) && newpage.Equals("Fields"))
                        newpage = "ContactFields";
                    break;
                case "Fields":
                    if (newpage.Equals("DomainAndRole") && !CheckFields())
                        return false;
                    break;
                case "DomainAndRole":
                    if (newpage.Equals("ContactFields"))
                    {
                        if (!CheckDomainAndRole())
                            return false;
                        StartImport();
                        newpage = "Importing";
                    }
                    break;

                case "ContactFields":
                    if (newpage.Equals("Importing"))
                    {
                        if (ImportAction == ImportActionType.ImportAsContact)
                        {
                            if (ContactIdentifier.Value.Equals(FormatDefaultText(Translate.Text("select field"))))
                            {
                                SheerResponse.Alert("Contact Identifier field must have a valid value");
                                return false;
                            }
                            StartImportingContacts();
                        }
                    }
                    else if (newpage.Equals("DomainAndRole"))
                    {
                        if (ImportAction == ImportActionType.ImportAsContact)
                            newpage = "SelectFile";
                    }
                    break;
                case "Importing":
                    if (newpage.Equals("Finish"))
                    {
                        if (ImportAction == ImportActionType.ImportAsContact)
                        {
                            LiteralUserExists.Text = "Contact exists:";
                            LiteralBadUserName.Text = "Invalid contact:";
                            LiteralUsersImported.Text = "Contacts imported:";
                            LiteralBrokenStructure.Visible = false;
                            NumBroken.Visible = false;
                        }
                        if (ImportAction == ImportActionType.ImportAsUser)
                        {
                            LiteralUserExists.Text = "User exists:";
                            LiteralBadUserName.Text = "Invalid user name:";
                            LiteralUsersImported.Text = "Users Imported:";
                            LiteralBrokenStructure.Visible = true;
                            NumBroken.Visible = true;
                        }
                    }
                    break;
            }
            return base.ActivePageChanging(page, ref newpage);
        }

        public new void Next()
        {
            var index = Pages.IndexOf(Active) + 1;
            if (index >= Pages.Count)
                Active = Pages[Pages.Count - 1];
            else
                Active = Pages[index];
        }

        private void InitializeFields()
        {
            for (var index = ParentControl.Controls.Count - 1; index >= 0; --index)
            {
                var control = ParentControl.Controls[index];
                if (!string.IsNullOrEmpty(control.ID) &&
                    (control.ID.StartsWith("Field") || control.ID.StartsWith("Property") ||
                     control.ID.StartsWith("DelSection")))
                    ParentControl.Controls.Remove(control);
            }
            InitializeUserNameField();
            InitializeContactFields();
            var prevIdPostfix = string.Empty;
            foreach (var str in FieldList)
            {
                var f = str;
                var defProperty = PropertyList.Find(p => string.Equals(f, p, StringComparison.OrdinalIgnoreCase));
                if (!string.IsNullOrEmpty(defProperty))
                    prevIdPostfix = AddRow(prevIdPostfix, defProperty);
            }
            AddRow(prevIdPostfix);
            SheerResponse.Refresh(FieldsSection);
        }

        private void InitializeContactFields()
        {
            ContactIdentifier.List = FieldList;
            ContactIdentifier.Value = FormatDefaultText(Translate.Text("select field"));
            ContactFirstName.List = FieldList;
            ContactFirstName.Value = FormatDefaultText(Translate.Text("select field"));
            ContactLastName.List = FieldList;
            ContactLastName.Value = FormatDefaultText(Translate.Text("select field"));
            ContactEmail.List = FieldList;
            ContactEmail.Value = FormatDefaultText(Translate.Text("select field"));
        }

        protected void StartImportingContacts()
        {
            var importOptions = new ContactImportOptions
            {
                FileName = RealFilename,
                PlanId = Tracker.DefinitionDatabase.GetItem(StateId).ParentID,
                StateId = StateId,
                ContactIdentifierField = ContactIdentifier.Value,
                ContactFirstNameField = ContactFirstName.Value,
                ContactLastNameField = ContactLastName.Value,
                ContactEmailField = ContactEmail.Value
            };
            StartJob("Import Contacts", "DoImportContacts", this, importOptions);
            CheckImport();
        }

        protected string DoImportContacts(ContactImportOptions options)
        {
            Assert.ArgumentNotNull(options, "options");
            var contactManager = Factory.CreateObject("tracking/contactManager", true) as ContactManager;
            var contactRepository = Factory.CreateObject("tracking/contactRepository", true) as ContactRepository;
            var numOfImported = 0;
            var numOfContactExists = 0;
            var numOfBadContacts = 0;
            var numOfContactsAddedToState = 0;
            using (var csvFileReader = new CsvFileReader(options.FileName))
            {
                try
                {
                    var columnNameFields = csvFileReader.ReadLine();
                    var contactIdentifierIndex =
                        columnNameFields.FindIndex(h => string.Equals(options.ContactIdentifierField, h));
                    if (contactIdentifierIndex < 0)
                        return string.Empty;

                    var contactFirstNameIndex =
                        columnNameFields.FindIndex(x => string.Equals(options.ContactFirstNameField, x));
                    var contactLastNameIndex =
                        columnNameFields.FindIndex(x => string.Equals(options.ContactLastNameField, x));
                    var contactEmailIndex = columnNameFields.FindIndex(x => string.Equals(options.ContactEmailField, x));

                    var valueFields = csvFileReader.ReadLine();
                    while (valueFields != null)
                    {
                        var contactIdentifier = valueFields[contactIdentifierIndex];
                        if (string.IsNullOrWhiteSpace(contactIdentifier))
                        {
                            numOfBadContacts++;
                        }
                        else
                        {
                            var leaseOwner = new LeaseOwner("AddContacts-" + Guid.NewGuid(),
                                LeaseOwnerType.OutOfRequestWorker);
                            LockAttemptResult<Contact> lockAttemptResult;
                            var contact = contactManager.LoadContactReadOnly(contactIdentifier);
                            if (contact != null)
                            {
                                numOfContactExists++;
                                lockAttemptResult = contactRepository.TryLoadContact(contact.ContactId, leaseOwner,
                                    TimeSpan.FromSeconds(3));
                                if (lockAttemptResult.Status == LockAttemptStatus.Success)
                                {
                                    contact = lockAttemptResult.Object;
                                    contact.ContactSaveMode = ContactSaveMode.AlwaysSave;
                                }
                                else
                                {
                                    Log.Error("Cannot lock contact! " + lockAttemptResult.Status, this);
                                }
                            }
                            else
                            {
                                contact = contactRepository.CreateContact(ID.NewID);
                                contact.Identifiers.Identifier = contactIdentifier;
                                contact.System.Value = 0;
                                contact.System.VisitCount = 0;
                                contact.ContactSaveMode = ContactSaveMode.AlwaysSave;
                                lockAttemptResult = new LockAttemptResult<Contact>(LockAttemptStatus.Success, contact,
                                    leaseOwner);
                            }
                            UpdateContactPersonalInfo(contact, contactFirstNameIndex, valueFields, contactLastNameIndex);
                            UpdateContactEmailAddress(contactEmailIndex, contact, valueFields);

                            if ((lockAttemptResult.Status != LockAttemptStatus.AlreadyLocked) &&
                                (lockAttemptResult.Status != LockAttemptStatus.NotFound))
                            {
                                if (contact.AutomationStates().IsInEngagementPlan(options.PlanId))
                                {
                                    contact.AutomationStates().MoveToEngagementState(options.PlanId, options.StateId);
                                    Log.Info(
                                        string.Format("Move contact: {0} to engagement plan stateId: {1}",
                                            contact.ContactId, options.StateId), this);
                                }
                                else
                                {
                                    contact.AutomationStates().EnrollInEngagementPlan(options.PlanId, options.StateId);
                                    Log.Info(
                                        string.Format("Enrolled contact: {0} to engagement plan stateId: {1}",
                                            contact.ContactId, options.StateId), this);
                                }

                                contactRepository.SaveContact(contact, new ContactSaveOptions(true, leaseOwner, null));
                                numOfContactsAddedToState++;
                            }
                            else
                            {
                                Log.Error(
                                    string.Format("Failed to enroll contact: {0} in engagement plan stateId: {1}",
                                        contact.ContactId, options.StateId), this);
                            }
                            numOfImported++;
                        }

                        valueFields = csvFileReader.ReadLine();
                    }
                }
                catch (Exception ex)
                {
                    Log.Error(ex.Message, ex, this);
                }
            }

            Log.Info(
                string.Format(
                    "Import Contacts Finished: Imported: {0}, Contact Exists: {1}, Bad Contact Data: {2}, Added to State: {3}",
                    numOfImported, numOfContactExists, numOfBadContacts, numOfContactsAddedToState), GetType());
            return numOfImported + "|" + numOfContactExists + "|" + numOfBadContacts + "|" + "|" +
                   numOfContactsAddedToState + "|";
        }

        private void UpdateContactPersonalInfo(Contact contact, int contactFirstNameIndex, List<string> valueFields,
            int contactLastNameIndex)
        {
            var contactPersonalInfoFacet = contact.GetFacet<IContactPersonalInfo>("Personal");
            if (contactFirstNameIndex >= 0)
                contactPersonalInfoFacet.FirstName = valueFields[contactFirstNameIndex];

            if (contactLastNameIndex >= 0)
                contactPersonalInfoFacet.Surname = valueFields[contactLastNameIndex];
        }

        private void UpdateContactEmailAddress(int contactEmailIndex, Contact contact, List<string> valueFields)
        {
            if (contactEmailIndex >= 0)
            {
                var contactEmailFacet = contact.GetFacet<IContactEmailAddresses>("Emails");
                contactEmailFacet.Preferred = "Preferred";
                if (contactEmailFacet.Entries.Contains("Preferred"))
                {
                    var preferredEmailAddress = contactEmailFacet.Entries["Preferred"];
                    preferredEmailAddress.SmtpAddress = valueFields[contactEmailIndex];
                }
                else
                {
                    var preferredEmailAddress = contactEmailFacet.Entries.Create("Preferred");
                    preferredEmailAddress.SmtpAddress = valueFields[contactEmailIndex];
                }
            }
        }

        protected class ContactImportOptions
        {
            public string FileName { get; set; }
            public ID PlanId { get; set; }
            public ID StateId { get; set; }
            public string ContactIdentifierField { get; set; }
            public string ContactFirstNameField { get; set; }
            public string ContactLastNameField { get; set; }
            public string ContactEmailField { get; set; }
        }

        protected enum ImportActionType
        {
            Unknown,
            ImportAsUser,
            ImportAsContact
        }

        #region Methods from base class

        protected new bool ReadFile()
        {
            if (string.IsNullOrEmpty(RealFilename))
            {
                SheerResponse.Alert(Translate.Text("Select a file first."));
                return false;
            }
            if (!FileUtil.FileExists(RealFilename))
            {
                SheerResponse.Alert(Translate.Text("'{0}' file does not exist.", (object) RealFilename));
                return false;
            }
            if (!RealFilename.Equals(LastFile))
                using (var csvFileReader = new CsvFileReader(RealFilename))
                {
                    FieldList = csvFileReader.ReadLine();
                    LastFile = RealFilename;
                    InitializeFields();
                }
            return true;
        }

        protected new void CheckImport()
        {
            var str = Context.ClientPage.ServerProperties["job"] as string;
            var job = !string.IsNullOrEmpty(str) ? JobManager.GetJob(Handle.Parse(str)) : null;
            if (job == null)
                Next();
            else if (job.IsDone)
            {
                if (job.Status.Result != null)
                    UpdateForm(job.Status.Result.ToString());
                Next();
            }
            else
                SheerResponse.Timer("CheckImport", 300);
        }

        private void UpdateForm(string results)
        {
            if (string.IsNullOrEmpty(results))
                return;
            var strArray = results.Split('|');
            if (strArray.Length < 5)
                return;
            NumImported.Text = strArray[0];
            NumUserExists.Text = strArray[1];
            NumBadUserName.Text = strArray[2];
            NumBroken.Text = strArray[3];
            NumAddedToState.Text = strArray[4];
            SheerResponse.Refresh(Results);
        }

        private void AddDelSection(string idPostfix)
        {
            Assert.ArgumentNotNull(idPostfix, "idPostfix");
            var imageBuilder = new ImageBuilder
            {
                Src = "Applications/16x16/delete2.png",
                Width = 16,
                Height = 16,
                Style = "cursor: pointer"
            };
            var literal = new Literal
            {
                Text = imageBuilder.ToString()
            };
            var border1 = new Border();
            border1.ID = "DelSection" + idPostfix;
            border1.Click = "DelSection_Click";
            var border2 = border1;
            border2.Controls.Add(literal);
            ParentControl.Controls.Add(border2);
        }

        private void AddFieldCombobox(string idPostfix, string defValue)
        {
            Assert.ArgumentNotNull(idPostfix, "idPostfix");
            var editableCombobox1 = new EditableCombobox();
            editableCombobox1.ID = "Field" + idPostfix;
            editableCombobox1.SelectOnly = true;
            editableCombobox1.List = FieldList;
            var editableCombobox2 = editableCombobox1;
            if (!string.IsNullOrEmpty(defValue))
                foreach (var str in FieldList)
                    if (defValue.Equals(str, StringComparison.OrdinalIgnoreCase))
                    {
                        editableCombobox2.Value = str;
                        break;
                    }
            if (string.IsNullOrEmpty(editableCombobox2.Value))
                editableCombobox2.Value =
                    HttpUtility.HtmlEncode(FormatDefaultText(Translate.Text("select to add field")));
            ParentControl.Controls.Add(editableCombobox2);
        }

        private void AddPropertyCombobox(string idPostfix, string defValue)
        {
            Assert.ArgumentNotNull(idPostfix, "idPostfix");
            var editableCombobox1 = new EditableCombobox();
            editableCombobox1.ID = "Property" + idPostfix;
            editableCombobox1.SelectOnly = true;
            editableCombobox1.List = PropertyList;
            var editableCombobox2 = editableCombobox1;
            if (string.IsNullOrEmpty(defValue))
                editableCombobox2.Value = HttpUtility.HtmlEncode(FormatDefaultText(Translate.Text("select property")));
            else
                foreach (var str in PropertyList)
                    if (defValue.Equals(str, StringComparison.OrdinalIgnoreCase))
                    {
                        editableCombobox2.Value = str;
                        break;
                    }
            ParentControl.Controls.Add(editableCombobox2);
        }

        private string AddRow(string prevIdPostfix)
        {
            return AddRow(prevIdPostfix, string.Empty);
        }

        private string AddRow(string prevIdPostfix, string defProperty)
        {
            var uniqueId = Control.GetUniqueID(string.Empty);
            if (!string.IsNullOrEmpty(prevIdPostfix))
                AddDelSection(prevIdPostfix);
            AddFieldCombobox(uniqueId, defProperty);
            AddPropertyCombobox(uniqueId, defProperty);
            return uniqueId;
        }

        private string FormatDefaultText(string text)
        {
            Assert.ArgumentNotNull(text, "text");
            return "<" + text + ">";
        }

        private void InitializeUserNameField()
        {
            UserName.List = FieldList;
            UserName.Value = FormatDefaultText(Translate.Text("select field"));
        }

        private void StartJob(string name, string method, object helper, params object[] args)
        {
            Assert.ArgumentNotNull(name, "name");
            Assert.ArgumentNotNull(method, "method");
            Assert.ArgumentNotNull(helper, "helper");
            var job = JobManager.Start(new JobOptions(name, method, Context.Site.Name, helper, method, args)
            {
                EnableSecurity = false,
                AfterLife = TimeSpan.FromSeconds(3.0),
                WriteToLog = true
            });
            try
            {
                Context.ClientPage.ServerProperties["job"] = job.Handle.ToString();
            }
            catch (Exception ex)
            {
                Log.Error(ex.Message, ex, this);
            }
        }

        #endregion
    }
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

using System;

using System.Collections.Generic;

using System.Web;

using Sitecore;

using Sitecore.Analytics;

using Sitecore.Analytics.Automation.MarketingAutomation;

using Sitecore.Analytics.Data;

using Sitecore.Analytics.DataAccess;

using Sitecore.Analytics.Model;

using Sitecore.Analytics.Model.Entities;

using Sitecore.Analytics.Tracking;

using Sitecore.Configuration;

using Sitecore.Data;

using Sitecore.Diagnostics;

using Sitecore.Globalization;

using Sitecore.IO;

using Sitecore.Jobs;

using Sitecore.Resources;

using Sitecore.Web.UI.HtmlControls;

using Sitecore.Web.UI.Sheer;

namespace TC.SitecoreEngagementPlanUI.Shell.Applications.MarketingAutomations.Dialogs

{

public class ImportVisitorsForm : Sitecore.Shell.Applications.MarketingAutomation.Dialogs.ImportVisitorsForm

{

protected EditableCombobox ContactEmail;

protected EditableCombobox ContactFirstName;

protected EditableCombobox ContactIdentifier;

protected EditableCombobox ContactLastName;

protected Radiobutton ImportContacts;

protected Radiobutton ImportUsers;

protected Literal LiteralBadUserName;

protected Literal LiteralBrokenStructure;

protected Literal LiteralUserExists;

protected Literal LiteralUsersImported;

protected ImportActionType ImportAction

{

get

{

if (ImportUsers.Checked)

return ImportActionType.ImportAsUser;

if (ImportContacts.Checked)

return ImportActionType.ImportAsContact;

return ImportActionType.Unknown;

}

protected override bool ActivePageChanging(string page, ref string newpage)

{

Assert.ArgumentNotNull(page, "page");

Assert.ArgumentNotNull(newpage, "newpage");

switch (page)

{

case "ChooseAction":

if (ImportAction == ImportActionType.Unknown)

{

SheerResponse.Alert("Please select one of the action available");

return false;

}

break;

case "SelectFile":

if (newpage.Equals("Fields") && !ReadFile())

return false;

if ((ImportAction == ImportActionType.ImportAsContact) && newpage.Equals("Fields"))

newpage = "ContactFields";

break;

case "Fields":

if (newpage.Equals("DomainAndRole") && !CheckFields())

return false;

break;

case "DomainAndRole":

if (newpage.Equals("ContactFields"))

{

if (!CheckDomainAndRole())

return false;

StartImport();

newpage = "Importing";

}

break;

case "ContactFields":

if (newpage.Equals("Importing"))

{

if (ImportAction == ImportActionType.ImportAsContact)

{

if (ContactIdentifier.Value.Equals(FormatDefaultText(Translate.Text("select field"))))

{

SheerResponse.Alert("Contact Identifier field must have a valid value");

return false;

}

StartImportingContacts();

}

else if (newpage.Equals("DomainAndRole"))

{

if (ImportAction == ImportActionType.ImportAsContact)

newpage = "SelectFile";

}

break;

case "Importing":

if (newpage.Equals("Finish"))

{

if (ImportAction == ImportActionType.ImportAsContact)

{

LiteralUserExists.Text = "Contact exists:";

LiteralBadUserName.Text = "Invalid contact:";

LiteralUsersImported.Text = "Contacts imported:";

LiteralBrokenStructure.Visible = false;

NumBroken.Visible = false;

}

if (ImportAction == ImportActionType.ImportAsUser)

{

LiteralUserExists.Text = "User exists:";

LiteralBadUserName.Text = "Invalid user name:";

LiteralUsersImported.Text = "Users Imported:";

LiteralBrokenStructure.Visible = true;

NumBroken.Visible = true;

}

break;

}

return base.ActivePageChanging(page, ref newpage);

}

public new void Next()

{

var index = Pages.IndexOf(Active) + 1;

if (index >= Pages.Count)

Active = Pages[Pages.Count - 1];

else

Active = Pages[index];

}

private void InitializeFields()

{

for (var index = ParentControl.Controls.Count - 1; index >= 0; --index)

{

var control = ParentControl.Controls[index];

if (!string.IsNullOrEmpty(control.ID) &&

(control.ID.StartsWith("Field") || control.ID.StartsWith("Property") ||

control.ID.StartsWith("DelSection")))

ParentControl.Controls.Remove(control);

}

InitializeUserNameField();

InitializeContactFields();

var prevIdPostfix = string.Empty;

foreach (var str in FieldList)

{

var f = str;

var defProperty = PropertyList.Find(p => string.Equals(f, p, StringComparison.OrdinalIgnoreCase));

if (!string.IsNullOrEmpty(defProperty))

prevIdPostfix = AddRow(prevIdPostfix, defProperty);

}

AddRow(prevIdPostfix);

SheerResponse.Refresh(FieldsSection);

}

private void InitializeContactFields()

{

ContactIdentifier.List = FieldList;

ContactIdentifier.Value = FormatDefaultText(Translate.Text("select field"));

ContactFirstName.List = FieldList;

ContactFirstName.Value = FormatDefaultText(Translate.Text("select field"));

ContactLastName.List = FieldList;

ContactLastName.Value = FormatDefaultText(Translate.Text("select field"));

ContactEmail.List = FieldList;

ContactEmail.Value = FormatDefaultText(Translate.Text("select field"));

}

protected void StartImportingContacts()

{

var importOptions = new ContactImportOptions

{

FileName = RealFilename,

PlanId = Tracker.DefinitionDatabase.GetItem(StateId).ParentID,

StateId = StateId,

ContactIdentifierField = ContactIdentifier.Value,

ContactFirstNameField = ContactFirstName.Value,

ContactLastNameField = ContactLastName.Value,

ContactEmailField = ContactEmail.Value

};

StartJob("Import Contacts", "DoImportContacts", this, importOptions);

CheckImport();

}

protected string DoImportContacts(ContactImportOptions options)

{

Assert.ArgumentNotNull(options, "options");

var contactManager = Factory.CreateObject("tracking/contactManager", true) as ContactManager;

var contactRepository = Factory.CreateObject("tracking/contactRepository", true) as ContactRepository;

var numOfImported = 0;

var numOfContactExists = 0;

var numOfBadContacts = 0;

var numOfContactsAddedToState = 0;

using (var csvFileReader = new CsvFileReader(options.FileName))

{

try

{

var columnNameFields = csvFileReader.ReadLine();

var contactIdentifierIndex =

columnNameFields.FindIndex(h => string.Equals(options.ContactIdentifierField, h));

if (contactIdentifierIndex < 0)

return string.Empty;

var contactFirstNameIndex =

columnNameFields.FindIndex(x => string.Equals(options.ContactFirstNameField, x));

var contactLastNameIndex =

columnNameFields.FindIndex(x => string.Equals(options.ContactLastNameField, x));

var contactEmailIndex = columnNameFields.FindIndex(x => string.Equals(options.ContactEmailField, x));

var valueFields = csvFileReader.ReadLine();

while (valueFields != null)

{

var contactIdentifier = valueFields[contactIdentifierIndex];

if (string.IsNullOrWhiteSpace(contactIdentifier))

{

numOfBadContacts++;

}

else

{

var leaseOwner = new LeaseOwner("AddContacts-" + Guid.NewGuid(),

LeaseOwnerType.OutOfRequestWorker);

LockAttemptResult<Contact> lockAttemptResult;

var contact = contactManager.LoadContactReadOnly(contactIdentifier);

if (contact != null)

{

numOfContactExists++;

lockAttemptResult = contactRepository.TryLoadContact(contact.ContactId, leaseOwner,

TimeSpan.FromSeconds(3));

if (lockAttemptResult.Status == LockAttemptStatus.Success)

{

contact = lockAttemptResult.Object;

contact.ContactSaveMode = ContactSaveMode.AlwaysSave;

}

else

{

Log.Error("Cannot lock contact! " + lockAttemptResult.Status, this);

}

else

{

contact = contactRepository.CreateContact(ID.NewID);

contact.Identifiers.Identifier = contactIdentifier;

contact.System.Value = 0;

contact.System.VisitCount = 0;

contact.ContactSaveMode = ContactSaveMode.AlwaysSave;

lockAttemptResult = new LockAttemptResult<Contact>(LockAttemptStatus.Success, contact,

leaseOwner);

}

UpdateContactPersonalInfo(contact, contactFirstNameIndex, valueFields, contactLastNameIndex);

UpdateContactEmailAddress(contactEmailIndex, contact, valueFields);

if ((lockAttemptResult.Status != LockAttemptStatus.AlreadyLocked) &&

(lockAttemptResult.Status != LockAttemptStatus.NotFound))

{

if (contact.AutomationStates().IsInEngagementPlan(options.PlanId))

{

contact.AutomationStates().MoveToEngagementState(options.PlanId, options.StateId);

Log.Info(

string.Format("Move contact: {0} to engagement plan stateId: {1}",

contact.ContactId, options.StateId), this);

}

else

{

contact.AutomationStates().EnrollInEngagementPlan(options.PlanId, options.StateId);

Log.Info(

string.Format("Enrolled contact: {0} to engagement plan stateId: {1}",

contact.ContactId, options.StateId), this);

}

contactRepository.SaveContact(contact, new ContactSaveOptions(true, leaseOwner, null));

numOfContactsAddedToState++;

}

else

{

Log.Error(

string.Format("Failed to enroll contact: {0} in engagement plan stateId: {1}",

contact.ContactId, options.StateId), this);

}

numOfImported++;

}

valueFields = csvFileReader.ReadLine();

}

catch (Exception ex)

{

Log.Error(ex.Message, ex, this);

}

Log.Info(

string.Format(

"Import Contacts Finished: Imported: {0}, Contact Exists: {1}, Bad Contact Data: {2}, Added to State: {3}",

numOfImported, numOfContactExists, numOfBadContacts, numOfContactsAddedToState), GetType());

return numOfImported + "|" + numOfContactExists + "|" + numOfBadContacts + "|" + "|" +

numOfContactsAddedToState + "|";

}

private void UpdateContactPersonalInfo(Contact contact, int contactFirstNameIndex, List<string> valueFields,

int contactLastNameIndex)

{

var contactPersonalInfoFacet = contact.GetFacet<IContactPersonalInfo>("Personal");

if (contactFirstNameIndex >= 0)

contactPersonalInfoFacet.FirstName = valueFields[contactFirstNameIndex];

if (contactLastNameIndex >= 0)

contactPersonalInfoFacet.Surname = valueFields[contactLastNameIndex];

}

private void UpdateContactEmailAddress(int contactEmailIndex, Contact contact, List<string> valueFields)

{

if (contactEmailIndex >= 0)

{

var contactEmailFacet = contact.GetFacet<IContactEmailAddresses>("Emails");

contactEmailFacet.Preferred = "Preferred";

if (contactEmailFacet.Entries.Contains("Preferred"))

{

var preferredEmailAddress = contactEmailFacet.Entries["Preferred"];

preferredEmailAddress.SmtpAddress = valueFields[contactEmailIndex];

}

else

{

var preferredEmailAddress = contactEmailFacet.Entries.Create("Preferred");

preferredEmailAddress.SmtpAddress = valueFields[contactEmailIndex];

}

protected class ContactImportOptions

{

public string FileName { get; set; }

public ID PlanId { get; set; }

public ID StateId { get; set; }

public string ContactIdentifierField { get; set; }

public string ContactFirstNameField { get; set; }

public string ContactLastNameField { get; set; }

public string ContactEmailField { get; set; }

}

protected enum ImportActionType

{

Unknown,

ImportAsUser,

ImportAsContact

}

#region Methods from base class

protected new bool ReadFile()

{

if (string.IsNullOrEmpty(RealFilename))

{

SheerResponse.Alert(Translate.Text("Select a file first."));

return false;

}

if (!FileUtil.FileExists(RealFilename))

{

SheerResponse.Alert(Translate.Text("'{0}' file does not exist.", (object) RealFilename));

return false;

}

if (!RealFilename.Equals(LastFile))

using (var csvFileReader = new CsvFileReader(RealFilename))

{

FieldList = csvFileReader.ReadLine();

LastFile = RealFilename;

InitializeFields();

}

return true;

}

protected new void CheckImport()

{

var str = Context.ClientPage.ServerProperties["job"] as string;

var job = !string.IsNullOrEmpty(str) ? JobManager.GetJob(Handle.Parse(str)) : null;

if (job == null)

Next();

else if (job.IsDone)

{

if (job.Status.Result != null)

UpdateForm(job.Status.Result.ToString());

Next();

}

else

SheerResponse.Timer("CheckImport", 300);

}

private void UpdateForm(string results)

{

if (string.IsNullOrEmpty(results))

return;

var strArray = results.Split('|');

if (strArray.Length < 5)

return;

NumImported.Text = strArray[0];

NumUserExists.Text = strArray[1];

NumBadUserName.Text = strArray[2];

NumBroken.Text = strArray[3];

NumAddedToState.Text = strArray[4];

SheerResponse.Refresh(Results);

}

private void AddDelSection(string idPostfix)

{

Assert.ArgumentNotNull(idPostfix, "idPostfix");

var imageBuilder = new ImageBuilder

{

Src = "Applications/16x16/delete2.png",

Width = 16,

Height = 16,

Style = "cursor: pointer"

};

var literal = new Literal

{

Text = imageBuilder.ToString()

};

var border1 = new Border();

border1.ID = "DelSection" + idPostfix;

border1.Click = "DelSection_Click";

var border2 = border1;

border2.Controls.Add(literal);

ParentControl.Controls.Add(border2);

}

private void AddFieldCombobox(string idPostfix, string defValue)

{

Assert.ArgumentNotNull(idPostfix, "idPostfix");

var editableCombobox1 = new EditableCombobox();

editableCombobox1.ID = "Field" + idPostfix;

editableCombobox1.SelectOnly = true;

editableCombobox1.List = FieldList;

var editableCombobox2 = editableCombobox1;

if (!string.IsNullOrEmpty(defValue))

foreach (var str in FieldList)

if (defValue.Equals(str, StringComparison.OrdinalIgnoreCase))

{

editableCombobox2.Value = str;

break;

}

if (string.IsNullOrEmpty(editableCombobox2.Value))

editableCombobox2.Value =

HttpUtility.HtmlEncode(FormatDefaultText(Translate.Text("select to add field")));

ParentControl.Controls.Add(editableCombobox2);

}

private void AddPropertyCombobox(string idPostfix, string defValue)

{

Assert.ArgumentNotNull(idPostfix, "idPostfix");

var editableCombobox1 = new EditableCombobox();

editableCombobox1.ID = "Property" + idPostfix;

editableCombobox1.SelectOnly = true;

editableCombobox1.List = PropertyList;

var editableCombobox2 = editableCombobox1;

if (string.IsNullOrEmpty(defValue))

editableCombobox2.Value = HttpUtility.HtmlEncode(FormatDefaultText(Translate.Text("select property")));

else

foreach (var str in PropertyList)

if (defValue.Equals(str, StringComparison.OrdinalIgnoreCase))

{

editableCombobox2.Value = str;

break;

}

ParentControl.Controls.Add(editableCombobox2);

}

private string AddRow(string prevIdPostfix)

{

return AddRow(prevIdPostfix, string.Empty);

}

private string AddRow(string prevIdPostfix, string defProperty)

{

var uniqueId = Control.GetUniqueID(string.Empty);

if (!string.IsNullOrEmpty(prevIdPostfix))

AddDelSection(prevIdPostfix);

AddFieldCombobox(uniqueId, defProperty);

AddPropertyCombobox(uniqueId, defProperty);

return uniqueId;

}

private string FormatDefaultText(string text)

{

Assert.ArgumentNotNull(text, "text");

return "<" + text + ">";

}

private void InitializeUserNameField()

{

UserName.List = FieldList;

UserName.Value = FormatDefaultText(Translate.Text("select field"));

}

private void StartJob(string name, string method, object helper, params object[] args)

{

Assert.ArgumentNotNull(name, "name");

Assert.ArgumentNotNull(method, "method");

Assert.ArgumentNotNull(helper, "helper");

var job = JobManager.Start(new JobOptions(name, method, Context.Site.Name, helper, method, args)

{

EnableSecurity = false,

AfterLife = TimeSpan.FromSeconds(3.0),

WriteToLog = true

});

try

{

Context.ClientPage.ServerProperties["job"] = job.Handle.ToString();

}

catch (Exception ex)

{

Log.Error(ex.Message, ex, this);

}

#endregion

}

The end result

Source Code is available in GitHub

Sitecore Server Role Checker Tool

January 24, 2017Issues & Resolution, Sitecore, Tips & Best Practicessitecore, sitecore how-to, sitecore tool, sitecore-tipsRey Rahadian

When configuring Sitecore in a distributed environment, you typically have more than 1 server in the production environment configured as a different roles (CM, CD, Processing, Reporting Service, etc).

More often than not I’ve noticed that issues are raised due to misconfiguration rather than implementation itself. You then go to Sitecore documentation site and check the configuration for each of the server that you’ve setup to see if there’s anything that you miss.

In the 8.0 documentation you would need to read a long list of tables containing information which config files that you need to enable/disable.

Since the 8.1 release, these steps are simplified with Sitecore providing us an excel spreadsheet file as a guide to enable/disable the config files depending on the role(s) that you want to setup. These steps are manual though and highly likely that we will miss one or two config files and could cause some issues down the line.

With the number of projects that you need to review, this task will start eating up your time and should really be automated. Some might have already done so and create a little tool tucked away somewhere.

I’ve decided to create my own version of the tool called Sitecore Server Role Checker, can’t be more obvious than that 🙂

How does it work?

This tool would basically uses a converted csv format from the Sitecore official spreadsheet guide and read the configuration based on your selected roles. It currently supports the following Sitecore version

8.1 update 3
8.2 initial release
8.2 update 1
8.2 update 2

Only those version is supported as those are only the spreadsheet available for now.

How do I use it?

Follow this simple steps

Choose your Sitecore version
Choose your search engine provider
Browse to your website folder
Tick your intended role(s) for this particular Sitecore instance
Click the Analyze button

It would then go through each of your configuration files and report if there’s any config files that should be enabled/disabled.

Through the tool you can also quickly disable/enable those config files.

What it doesn’t do

Check if your config files is updated accordingly, e.q:
- Changing robot detection handler in CM
- Configuring remote reporting service url
- etc
Check the configuration files for WFFM, EXM.. yet
Make you coffee

Where can I get it?

The code is available in Github

Note that this tool is not deeply tested, if you have any issues or suggestions with the tool then raise a ticket in Github or do a PR

update: 22 February 2017

The tool is now available at Sitecore Marketplace

Sitecore SOLR index update strategies in a scaled environment

November 17, 2016Analytics, Sitecore, Tips & Best Practicessitecore, sitecore-tipsRey Rahadian

Sitecore by default ships with two main search provider which is Lucene or SOLR.

I will not delve too much on which one you should use as that’s been covered in https://doc.sitecore.net/sitecore_experience_platform/setting_up__maintaining/search_and_indexing/indexing/using_solr_or_lucene

I’d like to highlight some of the points mentioned in the article, where using SOLR is mandatory:

You have a dedicated processing server
You have multiple CM servers

The main thing here is that if sitecore_analytics_index exist in multiple servers then you would need to use SOLR. But since all the indexes are now in a centralized server, what’s the index update strategies for SOLR would be?

Typically in this setup you would set

CM as the indexing server
- will perform index rebuild
- Set the index update strategies as you fit (except manual)
CD only reads from index
- Does not perform index rebuild
- Set the index update strategies to manual

If you have multiple CM server then you can set one of the CM as the one that perform index rebuild while the other one only reads from the index.

https://doc.sitecore.net/sitecore_experience_platform/setting_up__maintaining/search_and_indexing/indexing/index_update_strategies

Rebuild sitecore_analytics_index contact data

November 9, 2016Sitecore, Tips & Best Practicessitecore, sitecore-tipsRey Rahadian

There’s been an interesting question around how to rebuild the sitecore_analytics_index but specifically only for contact data.

As you’ve probably know that sitecore_analytics_index is not available to be indexed manually – go to the indexing manager in the control panel if you want to check. This is because the index is configured using an observer crawlers.

However there are ways to manually rebuild the sitecore_analytics_index. The example given in that seems to be specifically about rebuilding the interactions documents while what we want is to build the contacts.

I gained some hints from the provided example though, let’s have a look at the following code.

ContentSearchManager.GetIndex("sitecore_analytics_index").Reset();
var poolPath = "aggregationProcessing/processingPools/live";
var pool = Factory.CreateObject(poolPath, true) as ProcessingPool;
var driver = MongoDbDriver.FromConnectionString("analytics");
var visitorData = driver.Interactions.FindAllAs<VisitData>();
var keys = visitorData.Select(data => new InteractionKey(data.ContactId, data.InteractionId));
foreach(var key in keys)
{
    var poolItem = new ProcessingPoolItem(key.ToByteArray());
    pool.Add(poolItem);
}

ContentSearchManager.GetIndex("sitecore_analytics_index").Reset();

var poolPath = "aggregationProcessing/processingPools/live";

var pool = Factory.CreateObject(poolPath, true) as ProcessingPool;

var driver = MongoDbDriver.FromConnectionString("analytics");

var visitorData = driver.Interactions.FindAllAs<VisitData>();

var keys = visitorData.Select(data => new InteractionKey(data.ContactId, data.InteractionId));

foreach(var key in keys)

{

var poolItem = new ProcessingPoolItem(key.ToByteArray());

pool.Add(poolItem);

}

In particular this line

var poolPath = "aggregationProcessing/processingPools/live";

1	var poolPath = "aggregationProcessing/processingPools/live";

I then go to the handy showconfig.aspx page to find the following

<processingPools>
   <live type="Sitecore.Analytics.Data.MongoDb.ProcessingPool.MongoDbProcessingPool, Sitecore.Analytics.MongoDb" singleInstance="true">
      <param desc="connectionStringName">
      tracking.live</param>
      <Name>live</Name>
      <Enabled>true</Enabled>
      <MaxItemErrorCount ref="aggregationProcessing/maxItemErrorCount"/>
   </live>
   <history type="Sitecore.Analytics.Data.MongoDb.ProcessingPool.MongoDbProcessingPool, Sitecore.Analytics.MongoDb" singleInstance="true">
      <param desc="connectionStringName">
      tracking.history</param>
      <Name>history</Name>
      <Enabled>true</Enabled>
      <MaxItemErrorCount ref="aggregationProcessing/maxItemErrorCount"/>
   </history>
   <contact type="Sitecore.Analytics.Data.MongoDb.ProcessingPool.MongoDbProcessingPool, Sitecore.Analytics.MongoDb" singleInstance="true">
      <param desc="connectionStringName">
      tracking.contact</param>
      <DuplicateKeyStrategy>AllowAndMerge</DuplicateKeyStrategy>
      <Name>contact</Name>
      <Enabled>true</Enabled>
      <MaxItemErrorCount ref="aggregationProcessing/maxItemErrorCount"/>
   </contact>
   <pathAnalyzerLive type="Sitecore.PathAnalyzer.Processing.ProcessingPool, Sitecore.PathAnalyzer" singleInstance="true" patch:source="Sitecore.PathAnalyzer.Processing.config">
      <param desc="connectionStringName">
      tracking.live</param>
      <param desc="collectionName">
      PathAnalyzerProcessingPool</param>
      <DuplicateKeyStrategy>AllowAndMerge</DuplicateKeyStrategy>
      <Name>trees</Name>
      <Enabled>true</Enabled>
   </pathAnalyzerLive>
   <pathAnalyzerHistory type="Sitecore.PathAnalyzer.Processing.ProcessingPool, Sitecore.PathAnalyzer" singleInstance="true" patch:source="Sitecore.PathAnalyzer.Processing.config">
      <param desc="connectionStringName">
      tracking.history</param>
      <param desc="collectionName">
      PathAnalyzerProcessingPool</param>
      <DuplicateKeyStrategy>AllowAndMerge</DuplicateKeyStrategy>
      <Name>trees</Name>
      <Enabled>true</Enabled>
   </pathAnalyzerHistory>
</processingPools>

tracking.live</param>

</live>

tracking.history</param>

<Name>history</Name>

</history>

tracking.contact</param>

<DuplicateKeyStrategy>AllowAndMerge</DuplicateKeyStrategy>

<Name>contact</Name>

</contact>

tracking.live</param>

PathAnalyzerProcessingPool</param>

<DuplicateKeyStrategy>AllowAndMerge</DuplicateKeyStrategy>

<Name>trees</Name>

</pathAnalyzerLive>

tracking.history</param>

PathAnalyzerProcessingPool</param>

<DuplicateKeyStrategy>AllowAndMerge</DuplicateKeyStrategy>

<Name>trees</Name>

</pathAnalyzerHistory>

</processingPools>

Which shows the processingPools configured for the aggregation processes. From there I can spot the contact element definition which seems to be the one that I’m looking for and start building the code for it.

result:

ContentSearchManager.GetIndex("sitecore_analytics_index").Reset();
var poolPath = "aggregationProcessing/processingPools/contact";
var pool = Factory.CreateObject(poolPath, true) as ProcessingPool;
var driver = MongoDbDriver.FromConnectionString("analytics");
var contacts = driver.GetCollection("Contacts").FindAll().SetFields(new string[] {"_id"});
foreach(var contact in contacts)
{
var contactId = contact[0].AsGuid;
var poolItem = new ProcessingPoolItem(contactId.ToByteArray());
pool.Add(poolItem);
}

ContentSearchManager.GetIndex("sitecore_analytics_index").Reset();

var poolPath = "aggregationProcessing/processingPools/contact";

var pool = Factory.CreateObject(poolPath, true) as ProcessingPool;

var driver = MongoDbDriver.FromConnectionString("analytics");

var contacts = driver.GetCollection("Contacts").FindAll().SetFields(new string[] {"_id"});

foreach(var contact in contacts)

{

var contactId = contact[0].AsGuid;

var poolItem = new ProcessingPoolItem(contactId.ToByteArray());

pool.Add(poolItem);

}

Depending on your needs, you might want to only reindex known contacts for example. You can take the above example and adjust it yourself.

Sitecore 8 – Extending Experience Profile – Part 4 – Displaying Specific Interactions Data

August 29, 2016Experience Profile, SitecoreRey Rahadian

How to display specific interaction data

For this example, we would like to have a custom list in the Experience Profile where it listed the triggered page event when the site visitor downloaded a PDF file.

End result:

How to set this up

Setup a page event
Assign the page event to media items
Setup a custom tab in the Experience Profile
Register a new processors for Experience Profile
Wire things together

Source code link is available at the end of this post.

How to setup a new page event

First we need to create a page event through the content editor, we can do so by going to the /sitecore/system/Settings/Analytics/Page Events

In the below screenshot I’ve created a page event called “Download PDF File”

How to assign page event to a media item

There’s a tutorial on how to this on Sitecore documentation site

I’m using a page event rather than goal for this POC because this event “download a pdf” doesn’t necessarily lead to a conversion but more about the actions that the site visitors took that we want to be aware of.

In the screenshot below I’ve assigned the pdf files in the media library with my custom page event.

Now if there’s a site visitors that download the specified files on the website, Sitecore will trigger the page event and store the information in MongoDB which later on we will extract and display it in the Experience Profile.

How to setup the custom tab in Experience Profile

The content tree

We define three column to be displayed on the ListControl rendering.

The full list of the renderings

The SubPageCode rendering links to a javascript file downloadedpdffiles.js which will be executed when this item is loaded into the tab.

We can control the page size -the amount of records returned by the server- in the GenericDataProvider properties.

How to register a new processors for the Experience Profile

Jonathan Robbin’s blog post explain it nicely on what this processors is doing.

Schema.cs

using System;
using Sitecore.Cintel.Reporting;

namespace Sitecore.TC.ExperienceProfile.CIntel.Reporting.Contact.DownloadedPdfFiles
{
	public static class Schema
	{
		public static string ViewName = "DownloadedPdfFiles";		
		public static ViewField<string> FileName = new ViewField<string>("FileName");
		public static ViewField<string> FileItemPath = new ViewField<string>("FileItemPath");
		public static ViewField<string> PageName = new ViewField<string>("PageName");
		public static ViewField<string> PageItemPath = new ViewField<string>("PageItemPath");
		public static ViewField<DateTime> DownloadedOn = new ViewField<DateTime>("DownloadedOn");
	}
}

using System;

using Sitecore.Cintel.Reporting;

namespace Sitecore.TC.ExperienceProfile.CIntel.Reporting.Contact.DownloadedPdfFiles

{

public static class Schema

{

public static string ViewName = "DownloadedPdfFiles";

public static ViewField<string> FileName = new ViewField<string>("FileName");

public static ViewField<string> FileItemPath = new ViewField<string>("FileItemPath");

public static ViewField<string> PageName = new ViewField<string>("PageName");

public static ViewField<string> PageItemPath = new ViewField<string>("PageItemPath");

public static ViewField<DateTime> DownloadedOn = new ViewField<DateTime>("DownloadedOn");

}

ConstructDownloadedPdfFilesDataTable.cs

using System.Data;
using Sitecore.Cintel.Reporting;
using Sitecore.Cintel.Reporting.Processors;

namespace Sitecore.TC.ExperienceProfile.CIntel.Reporting.Contact.DownloadedPdfFiles
{
	public class ConstructDownloadedPdfFilesDataTable : ReportProcessorBase
	{
		public override void Process(ReportProcessorArgs args)
		{
			args.ResultTableForView = new DataTable();
			args.ResultTableForView.Columns.Add(Schema.FileName.ToColumn());
			args.ResultTableForView.Columns.Add(Schema.FileItemPath.ToColumn());
			args.ResultTableForView.Columns.Add(Schema.PageName.ToColumn());
			args.ResultTableForView.Columns.Add(Schema.PageItemPath.ToColumn());
			args.ResultTableForView.Columns.Add(Schema.DownloadedOn.ToColumn());
		}
	}
}

using System.Data;

using Sitecore.Cintel.Reporting;

using Sitecore.Cintel.Reporting.Processors;

namespace Sitecore.TC.ExperienceProfile.CIntel.Reporting.Contact.DownloadedPdfFiles

{

public class ConstructDownloadedPdfFilesDataTable : ReportProcessorBase

{

public override void Process(ReportProcessorArgs args)

{

args.ResultTableForView = new DataTable();

args.ResultTableForView.Columns.Add(Schema.FileName.ToColumn());

args.ResultTableForView.Columns.Add(Schema.FileItemPath.ToColumn());

args.ResultTableForView.Columns.Add(Schema.PageName.ToColumn());

args.ResultTableForView.Columns.Add(Schema.PageItemPath.ToColumn());

args.ResultTableForView.Columns.Add(Schema.DownloadedOn.ToColumn());

}

PopulateDownloadedPdfFilesWithXdbData.cs

using System;
using System.Data;
using System.Globalization;
using Sitecore.Cintel.Reporting;
using Sitecore.Cintel.Reporting.Processors;

namespace Sitecore.TC.ExperienceProfile.CIntel.Reporting.Contact.DownloadedPdfFiles
{
	/// <summary>
	/// Responsible to populate the result table with the data coming from xDB
	/// </summary>
	public class PopulateDownloadedPdfFilesWithXdbData : ReportProcessorBase
	{
		private readonly Guid _downloadPdfFilePageEventItemId = new Guid("{C7C9427A-0EC3-4DBB-BF80-6864489102AC}");

		public override void Process(ReportProcessorArgs args)
		{
			var queryResult = args.QueryResult;
			var resultTableForView = args.ResultTableForView;

			foreach (var sourceRow in queryResult.AsEnumerable())
				if (!RowShouldBeSkipped(sourceRow))
				{
					var dataRow = resultTableForView.NewRow();

					var mediaPath = sourceRow.Field<string>("Pages_PageEvents_DataKey");
					var mediaItem = Context.Database.GetItem(mediaPath);
					if (mediaItem != null)
					{
						dataRow.SetField(Schema.FileName.Name, mediaItem.DisplayName);
						dataRow.SetField(Schema.FileItemPath.Name, mediaPath);
					}

					var pageItemId = sourceRow.Field<Guid>("Pages_Item__id");
					var pageItem = GetItemFromCurrentContext(pageItemId);
					if (pageItem != null)
					{
						dataRow.SetField(Schema.PageName.Name, pageItem.DisplayName);
						dataRow.SetField(Schema.PageItemPath.Name, pageItem.Paths.FullPath);
					}
					var datetime = sourceRow.Field<DateTime>("Pages_PageEvents_DateTime").ToLocalTime();
					dataRow.SetField(Schema.DownloadedOn.Name, datetime.ToString(CultureInfo.CurrentUICulture));

					resultTableForView.Rows.Add(dataRow);
				}
		}

		/// <summary>
		/// Skip processing the current row if it's the page event that we want to process
		/// </summary>
		/// <param name="row"></param>
		/// <returns></returns>
		private bool RowShouldBeSkipped(DataRow row)
		{
			return row.Field<Guid?>("Pages_PageEvents_PageEventDefinitionId").GetValueOrDefault() !=
			       _downloadPdfFilePageEventItemId;
		}
	}
}

using System;

using System.Data;

using System.Globalization;

using Sitecore.Cintel.Reporting;

using Sitecore.Cintel.Reporting.Processors;

namespace Sitecore.TC.ExperienceProfile.CIntel.Reporting.Contact.DownloadedPdfFiles

{

/// <summary>

/// Responsible to populate the result table with the data coming from xDB

/// </summary>

public class PopulateDownloadedPdfFilesWithXdbData : ReportProcessorBase

{

private readonly Guid _downloadPdfFilePageEventItemId = new Guid("{C7C9427A-0EC3-4DBB-BF80-6864489102AC}");

public override void Process(ReportProcessorArgs args)

{

var queryResult = args.QueryResult;

var resultTableForView = args.ResultTableForView;

foreach (var sourceRow in queryResult.AsEnumerable())

if (!RowShouldBeSkipped(sourceRow))

{

var dataRow = resultTableForView.NewRow();

var mediaPath = sourceRow.Field<string>("Pages_PageEvents_DataKey");

var mediaItem = Context.Database.GetItem(mediaPath);

if (mediaItem != null)

{

dataRow.SetField(Schema.FileName.Name, mediaItem.DisplayName);

dataRow.SetField(Schema.FileItemPath.Name, mediaPath);

}

var pageItemId = sourceRow.Field<Guid>("Pages_Item__id");

var pageItem = GetItemFromCurrentContext(pageItemId);

if (pageItem != null)

{

dataRow.SetField(Schema.PageName.Name, pageItem.DisplayName);

dataRow.SetField(Schema.PageItemPath.Name, pageItem.Paths.FullPath);

}

var datetime = sourceRow.Field<DateTime>("Pages_PageEvents_DateTime").ToLocalTime();

dataRow.SetField(Schema.DownloadedOn.Name, datetime.ToString(CultureInfo.CurrentUICulture));

resultTableForView.Rows.Add(dataRow);

}

/// <summary>

/// Skip processing the current row if it's the page event that we want to process

/// </summary>

/// <param name="row"></param>

/// <returns></returns>

private bool RowShouldBeSkipped(DataRow row)

{

return row.Field<Guid?>("Pages_PageEvents_PageEventDefinitionId").GetValueOrDefault() !=

_downloadPdfFilePageEventItemId;

}

TC.Sitecore.ExperienceProfile.Reporting.config

<?xml version="1.0" encoding="utf-8"?>

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
	<sitecore>
		<pipelines>
			<group groupName="ExperienceProfileContactViews">
				<pipelines>
					<downloadedpdffiles>
						<processor type="Sitecore.TC.ExperienceProfile.CIntel.Reporting.Contact.DownloadedPdfFiles.ConstructDownloadedPdfFilesDataTable, Sitecore.TC.ExperienceProfile" />
						<processor type="Sitecore.Cintel.Reporting.Processors.ExecuteReportingServerDatasourceQuery, Sitecore.Cintel">
							<param desc="queryName">visit-events-query</param>
						</processor>
						<processor type="Sitecore.TC.ExperienceProfile.CIntel.Reporting.Contact.DownloadedPdfFiles.PopulateDownloadedPdfFilesWithXdbData, Sitecore.TC.ExperienceProfile" />
						<processor type="Sitecore.Cintel.Reporting.Processors.ApplySorting, Sitecore.Cintel"/>
						<processor type="Sitecore.Cintel.Reporting.Processors.ApplyPaging, Sitecore.Cintel"/>
					</downloadedpdffiles>					
				</pipelines>
			</group>			
		</pipelines>
	</sitecore>
</configuration>

<?xml version="1.0" encoding="utf-8"?>

<param desc="queryName">visit-events-query</param>

</processor>

</downloadedpdffiles>

</pipelines>

</group>

</pipelines>

</sitecore>

</configuration>

notice that the sorting and paging is already built in the framework.

TC.Sitecore.ExperienceProfile.Client.config

<?xml version="1.0"?>
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
	<sitecore>
		<pipelines>
			<initialize>
				<!-- Creates a set of http endpoints that expose our custom fields on a contact. -->
				<processor type="Sitecore.TC.ExperienceProfile.CIntel.Endpoint.Plumbing.InitializeRoutes, Sitecore.TC.ExperienceProfile" patch:after="*[last()]" />
			</initialize>
		</pipelines>
	</sitecore>
</configuration>

<?xml version="1.0"?>

</initialize>

</pipelines>

</sitecore>

</configuration>

Wire things together

As with the previous post, when the DownloadedPdfFilesPanel item is loaded we will trigger an API call to request the data to be displayed in the list control

The javascript file that’s responsible to do this is the downloadedpdffiles.js

define(["sitecore", "/-/speak/v1/experienceprofile/DataProviderHelper.js", "/-/speak/v1/experienceprofile/CintelUtl.js"], function (sc, providerHelper, cintelUtil) {
	var app = sc.Definitions.App.extend({
		initialized: function () {
			var tableName = "downloadedpdffiles"; // Case Sensitive!
			var localUrl = "/intel/" + tableName;

			providerHelper.setupHeaders([
				{ urlKey: localUrl + "?", headerValue: "none" }
			]);

			var url = sc.Contact.baseUrl + localUrl;

			providerHelper.initProvider(this.DownloadedPdfFilesDataProvider, tableName, url, this.DownloadedPdfFilesTabMessageBar);
			providerHelper.subscribeSorting(this.DownloadedPdfFilesDataProvider, this.DownloadedPdfFiles);
			providerHelper.getListData(this.DownloadedPdfFilesDataProvider);									
		}
	});
	return app;
});

define(["sitecore", "/-/speak/v1/experienceprofile/DataProviderHelper.js", "/-/speak/v1/experienceprofile/CintelUtl.js"], function (sc, providerHelper, cintelUtil) {

var app = sc.Definitions.App.extend({

initialized: function () {

var tableName = "downloadedpdffiles"; // Case Sensitive!

var localUrl = "/intel/" + tableName;

providerHelper.setupHeaders([

{ urlKey: localUrl + "?", headerValue: "none" }

]);

var url = sc.Contact.baseUrl + localUrl;

providerHelper.initProvider(this.DownloadedPdfFilesDataProvider, tableName, url, this.DownloadedPdfFilesTabMessageBar);

providerHelper.subscribeSorting(this.DownloadedPdfFilesDataProvider, this.DownloadedPdfFiles);

providerHelper.getListData(this.DownloadedPdfFilesDataProvider);

}

});

return app;

});

The difference here compared to the previous post when triggering the API call is that we specify the /intel/downloadedpdffiles in the url which Sitecore recognize to be a special route. This route will try to run donwnloadedpdffiles pipelines that we define earlier in the config file.

An example of the API response

http://habitat.dev.local/sitecore/api/ao/v1/contacts/02b2e6c4-d38a-4e30-a18e-b4a31b63907d/intel/downloadedpdffiles?&pageSize=3&pageNumber=1

Source code

Source code is available in Github

Sitecore 8 – Extending Experience Profile – Part 3 – Displaying Contact Facet Collection Property

August 28, 2016Experience Profile, SitecoreRey Rahadian

How to display contact facet collection property

End result:

How to set this up

Setup a custom contact facet
Setup a web API controller to return the custom contact facet as JSON
Setup a custom tab in Experience Profile
Wire things together

Source code link is available at the end of this post.

How to setup the custom contact facet

Similar to what we’ve done in the first post, the only difference here is that we are using collection property instead of simple properties.

using Sitecore.Analytics.Model.Framework;

namespace Sitecore.TC.ExperienceProfile.ContactFacets
{
	public interface INewsletterSubscriptionFacet : IFacet
	{
		IElementCollection<INewsletterElement> Newsletters { get; }
	}
}

using Sitecore.Analytics.Model.Framework;

namespace Sitecore.TC.ExperienceProfile.ContactFacets

{

public interface INewsletterSubscriptionFacet : IFacet

{

IElementCollection<INewsletterElement> Newsletters { get; }

}

using Sitecore.Analytics.Model.Framework;

namespace Sitecore.TC.ExperienceProfile.ContactFacets
{
	public interface INewsletterElement : IElement
	{
		string NewsletterName { get; set; }		
	}
}

using Sitecore.Analytics.Model.Framework;

namespace Sitecore.TC.ExperienceProfile.ContactFacets

{

public interface INewsletterElement : IElement

{

string NewsletterName { get; set; }

}

using System;
using Sitecore.Analytics.Model.Framework;

namespace Sitecore.TC.ExperienceProfile.ContactFacets
{
	[Serializable]
	public class NewsletterSubscriptionFacet : Facet, INewsletterSubscriptionFacet
	{
		public const string FACET_NAME = "NewsletterSubscriptions";
		private const string NEWSLETTERS = "Newsletters";
		public NewsletterSubscriptionFacet()
		{
			EnsureCollection<INewsletterElement>(NEWSLETTERS);
		}

		public IElementCollection<INewsletterElement> Newsletters
		{
			get { return GetCollection<INewsletterElement>(NEWSLETTERS); }
		}
	}
}

using System;

using Sitecore.Analytics.Model.Framework;

namespace Sitecore.TC.ExperienceProfile.ContactFacets

{

[Serializable]

public class NewsletterSubscriptionFacet : Facet, INewsletterSubscriptionFacet

{

public const string FACET_NAME = "NewsletterSubscriptions";

private const string NEWSLETTERS = "Newsletters";

public NewsletterSubscriptionFacet()

{

EnsureCollection<INewsletterElement>(NEWSLETTERS);

}

public IElementCollection<INewsletterElement> Newsletters

{

get { return GetCollection<INewsletterElement>(NEWSLETTERS); }

}

using System;
using Sitecore.Analytics.Model.Framework;

namespace Sitecore.TC.ExperienceProfile.ContactFacets
{
	[Serializable]
	public class NewsletterElement : Element, INewsletterElement
	{
		private const string NEWSLETTER_NAME = "NewsletterName";
		public NewsletterElement()
		{
			EnsureAttribute<string>(NEWSLETTER_NAME);
		}

		public string NewsletterName
		{
			get { return GetAttribute<string>(NEWSLETTER_NAME); }
			set { SetAttribute(NEWSLETTER_NAME, value); }
		}
	}
}

using System;

using Sitecore.Analytics.Model.Framework;

namespace Sitecore.TC.ExperienceProfile.ContactFacets

{

[Serializable]

public class NewsletterElement : Element, INewsletterElement

{

private const string NEWSLETTER_NAME = "NewsletterName";

public NewsletterElement()

{

EnsureAttribute<string>(NEWSLETTER_NAME);

}

public string NewsletterName

{

get { return GetAttribute<string>(NEWSLETTER_NAME); }

set { SetAttribute(NEWSLETTER_NAME, value); }

}

The updated TC.Sitecore.Analytics.Model.config file

<?xml version="1.0" encoding="utf-8"?>

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
	<sitecore>
		<model>
			<elements>				
				<element interface="Sitecore.TC.ExperienceProfile.ContactFacets.ICustomFieldsFacet, Sitecore.TC.ExperienceProfile"
				         implementation="Sitecore.TC.ExperienceProfile.ContactFacets.CustomFieldsFacet, Sitecore.TC.ExperienceProfile" />
				<element interface="Sitecore.TC.ExperienceProfile.ContactFacets.INewsletterSubscriptionFacet, Sitecore.TC.ExperienceProfile"
				implementation="Sitecore.TC.ExperienceProfile.ContactFacets.NewsletterSubscriptionFacet, Sitecore.TC.ExperienceProfile" />
				<element interface="Sitecore.TC.ExperienceProfile.ContactFacets.INewsletterElement, Sitecore.TC.ExperienceProfile"
				         implementation="Sitecore.TC.ExperienceProfile.ContactFacets.NewsletterElement, Sitecore.TC.ExperienceProfile" />
			</elements>
			<entities>
				<contact>					
					<facets>						
						<facet name="CustomFields"
						       contract="Sitecore.TC.ExperienceProfile.ContactFacets.ICustomFieldsFacet, Sitecore.TC.ExperienceProfile" />
						<facet name="NewsletterSubscriptions"
						       contract="Sitecore.TC.ExperienceProfile.ContactFacets.INewsletterSubscriptionFacet, Sitecore.TC.ExperienceProfile" />
					</facets>
				</contact>
			</entities>
		</model>
	</sitecore>
</configuration>

<?xml version="1.0" encoding="utf-8"?>

<model>

<element interface="Sitecore.TC.ExperienceProfile.ContactFacets.ICustomFieldsFacet, Sitecore.TC.ExperienceProfile"

implementation="Sitecore.TC.ExperienceProfile.ContactFacets.CustomFieldsFacet, Sitecore.TC.ExperienceProfile" />

<element interface="Sitecore.TC.ExperienceProfile.ContactFacets.INewsletterSubscriptionFacet, Sitecore.TC.ExperienceProfile"

implementation="Sitecore.TC.ExperienceProfile.ContactFacets.NewsletterSubscriptionFacet, Sitecore.TC.ExperienceProfile" />

<element interface="Sitecore.TC.ExperienceProfile.ContactFacets.INewsletterElement, Sitecore.TC.ExperienceProfile"

implementation="Sitecore.TC.ExperienceProfile.ContactFacets.NewsletterElement, Sitecore.TC.ExperienceProfile" />

</elements>

<facet name="CustomFields"

contract="Sitecore.TC.ExperienceProfile.ContactFacets.ICustomFieldsFacet, Sitecore.TC.ExperienceProfile" />

<facet name="NewsletterSubscriptions"

contract="Sitecore.TC.ExperienceProfile.ContactFacets.INewsletterSubscriptionFacet, Sitecore.TC.ExperienceProfile" />

</facets>

</contact>

</entities>

</model>

</sitecore>

</configuration>

note that we need to register our INewsletterElement as well in order for Sitecore to know which type to resolve during runtime.

An example of how the data is being stored in MongoDB

How to setup the web API controller

The updated InitializeRoutes.cs

using System.Web.Http;
using System.Web.Routing;
using Sitecore.Pipelines;

namespace Sitecore.TC.ExperienceProfile.CIntel.Endpoint.Plumbing
{
	public class InitializeRoutes
	{
		public virtual void Process(PipelineArgs args)
		{
			RegisterRoutes(RouteTable.Routes, args);
		}

		protected virtual void RegisterRoutes(RouteCollection routes, PipelineArgs args)
		{
			routes.MapHttpRoute("tc_customcontact_customfields", "sitecore/api/ao/v1/contacts/{contactId}/customfields", (object)new
			{
				controller = "CustomContact",
				action = "GetCustomFields"
			});
			routes.MapHttpRoute("tc_customcontact_newslettersubscriptions", "sitecore/api/ao/v1/contacts/{contactId}/newslettersubscriptions", (object)new
			{
				controller = "CustomContact",
				action = "GetNewletterSubscriptions"
			});
		}
	}
}

using System.Web.Http;

using System.Web.Routing;

using Sitecore.Pipelines;

namespace Sitecore.TC.ExperienceProfile.CIntel.Endpoint.Plumbing

{

public class InitializeRoutes

{

public virtual void Process(PipelineArgs args)

{

RegisterRoutes(RouteTable.Routes, args);

}

protected virtual void RegisterRoutes(RouteCollection routes, PipelineArgs args)

{

routes.MapHttpRoute("tc_customcontact_customfields", "sitecore/api/ao/v1/contacts/{contactId}/customfields", (object)new

{

controller = "CustomContact",

action = "GetCustomFields"

});

routes.MapHttpRoute("tc_customcontact_newslettersubscriptions", "sitecore/api/ao/v1/contacts/{contactId}/newslettersubscriptions", (object)new

{

controller = "CustomContact",

action = "GetNewletterSubscriptions"

});

}

The updated CustomContactController.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
using Sitecore.Analytics.Tracking;
using Sitecore.Cintel.Commons;
using Sitecore.Cintel.ContactService;
using Sitecore.Cintel.Endpoint.Plumbing;
using Sitecore.Configuration;
using Sitecore.Diagnostics;
using Sitecore.TC.ExperienceProfile.ContactFacets;

namespace Sitecore.TC.ExperienceProfile.CIntel.Endpoint
{
	[AuthorizedReportingUserFilter]
	public class CustomContactController : ApiController
	{
		[HttpGet]
		public object GetCustomFields(Guid contactId)
		{
			try
			{
				var contactManager = GetContactManager();
				var contact = contactManager.LoadContactReadOnly(contactId);
				if (contact == null)
				{
					throw new ContactNotFoundException();
				}

				var customFacet = contact.GetFacet<ICustomFieldsFacet>(CustomFieldsFacet.FACET_NAME);
				return customFacet;
			}
			catch (ContactNotFoundException ex)
			{
				return Request.CreateResponse(HttpStatusCode.NotFound, ex.Message);
			}
		}

		private static ContactManager GetContactManager()
		{
			var contactManager = Factory.CreateObject("tracking/contactManager", true) as ContactManager;
			Assert.IsNotNull(contactManager, "Could not create instance of ContactManager");

			return contactManager;
		}

		[HttpGet]
		public object GetNewletterSubscriptions(Guid contactId)
		{
			try
			{
				var contactManager = GetContactManager();
				var contact = contactManager.LoadContactReadOnly(contactId);
				if (contact == null)
				{
					throw new ContactNotFoundException();
				}

				var customFacet = contact.GetFacet<INewsletterSubscriptionFacet>(NewsletterSubscriptionFacet.FACET_NAME);
				var resultSet = new ResultSet<List<INewsletterElement>>(1, 100);
				if (!customFacet.Newsletters.Any())
				{
					return resultSet;
				}

				resultSet.TotalResultCount = customFacet.Newsletters.Count;
				resultSet.Data.Dataset.Add("newsletters", customFacet.Newsletters.ToList());

				return resultSet;
			}
			catch (ContactNotFoundException ex)
			{
				return Request.CreateResponse(HttpStatusCode.NotFound, ex.Message);
			}
		}
	}
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Net;

using System.Net.Http;

using System.Web.Http;

using Sitecore.Analytics.Tracking;

using Sitecore.Cintel.Commons;

using Sitecore.Cintel.ContactService;

using Sitecore.Cintel.Endpoint.Plumbing;

using Sitecore.Configuration;

using Sitecore.Diagnostics;

using Sitecore.TC.ExperienceProfile.ContactFacets;

namespace Sitecore.TC.ExperienceProfile.CIntel.Endpoint

{

[AuthorizedReportingUserFilter]

public class CustomContactController : ApiController

{

[HttpGet]

public object GetCustomFields(Guid contactId)

{

try

{

var contactManager = GetContactManager();

var contact = contactManager.LoadContactReadOnly(contactId);

if (contact == null)

{

throw new ContactNotFoundException();

}

var customFacet = contact.GetFacet<ICustomFieldsFacet>(CustomFieldsFacet.FACET_NAME);

return customFacet;

}

catch (ContactNotFoundException ex)

{

return Request.CreateResponse(HttpStatusCode.NotFound, ex.Message);

}

private static ContactManager GetContactManager()

{

var contactManager = Factory.CreateObject("tracking/contactManager", true) as ContactManager;

Assert.IsNotNull(contactManager, "Could not create instance of ContactManager");

return contactManager;

}

[HttpGet]

public object GetNewletterSubscriptions(Guid contactId)

{

try

{

var contactManager = GetContactManager();

var contact = contactManager.LoadContactReadOnly(contactId);

if (contact == null)

{

throw new ContactNotFoundException();

}

var customFacet = contact.GetFacet<INewsletterSubscriptionFacet>(NewsletterSubscriptionFacet.FACET_NAME);

var resultSet = new ResultSet<List<INewsletterElement>>(1, 100);

if (!customFacet.Newsletters.Any())

{

return resultSet;

}

resultSet.TotalResultCount = customFacet.Newsletters.Count;

resultSet.Data.Dataset.Add("newsletters", customFacet.Newsletters.ToList());

return resultSet;

}

catch (ContactNotFoundException ex)

{

return Request.CreateResponse(HttpStatusCode.NotFound, ex.Message);

}

The main reason why we are returning as a ResultSet object here is that the list control rendering expects the returned data in a specific JSON structure.

While going through this I thought of the performance implications if we have a lot of data where we should ideally implement pagination when querying against MongoDB. For this POC, this works fine as for newsletters typically the users won’t have thousands of records to be displayed .

An example on how to implement pagination will be provided in the next post.

How to setup a custom tab in Experience Profile

The content tree

Under the NewsletterSubscriptionPanel item you can that there’s NewsletterSubscriptions which based on ListControl template, under that we have the NewsletterName which is using the ColumnField template.

When we use the list control rendering, we can specify what columns are there in the list control and bind the value with a specific property name returned from the API

The full list of the renderings used

note that there’s “more” button assigned to the layout, but this didn’t actually being used. That’s for future improvements when we implement pagination.

Wire things together

As with the previous post, when the NewsletterSubscriptionPanel item is loaded we will trigger an API call to request the data to be displayed in the list control

The javascript file that’s responsible to do this is the newslettersubscriptions.js

define(["sitecore", "/-/speak/v1/experienceprofile/DataProviderHelper.js", "/-/speak/v1/experienceprofile/CintelUtl.js"], function (sc, providerHelper, cintelUtil) {
	var app = sc.Definitions.App.extend({
		initialized: function () {
			var localUrl = "/newslettersubscriptions/";
			var tableName = "newsletters";
			providerHelper.setupHeaders([
				{ urlKey: localUrl }
			]);

			var url = sc.Contact.baseUrl + localUrl;			

			providerHelper.initProvider(this.NewsletterSubscriptionsDataProvider, tableName, url, this.NewsletterSubscriptionsMessageBar);			
			providerHelper.getListData(this.NewsletterSubscriptionsDataProvider);			
		}
	});
	return app;
});

define(["sitecore", "/-/speak/v1/experienceprofile/DataProviderHelper.js", "/-/speak/v1/experienceprofile/CintelUtl.js"], function (sc, providerHelper, cintelUtil) {

var app = sc.Definitions.App.extend({

initialized: function () {

var localUrl = "/newslettersubscriptions/";

var tableName = "newsletters";

providerHelper.setupHeaders([

{ urlKey: localUrl }

]);

var url = sc.Contact.baseUrl + localUrl;

providerHelper.initProvider(this.NewsletterSubscriptionsDataProvider, tableName, url, this.NewsletterSubscriptionsMessageBar);

providerHelper.getListData(this.NewsletterSubscriptionsDataProvider);

}

});

return app;

});

An example of the API response

http://habitat.dev.local/sitecore/api/ao/v1/contacts/02b2e6c4-d38a-4e30-a18e-b4a31b63907d/newslettersubscriptions/?&pageNumber=1

note that it has to return the response in a specific JSON structure that the list control can consume.

Source code

Source code is available in Github

Integration with the developer experience

Integration with JIRA

Integration with Team City

Integration with Bitbucket

Share this:

Like this:

The problem

The solution

The setup in Team City

TDS Delta packages generated.. what now?

What’s the outcome?

Share this:

Like this:

Create a custom log appender

Install Graylog server

Configure Graylog server

Send Sitecore log information to Graylog server

Check if things works as expected

Share this:

Like this:

Share this:

Like this:

Share this:

Like this:

How does it work?

How do I use it?

What it doesn’t do

Where can I get it?

Share this:

Like this:

Share this:

Like this:

Share this:

Like this:

Share this:

Like this:

Share this:

Like this: